jepler/textual
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Restore the content of docs.md

Browse source
This commit is contained in:
Dave Pearson 2022-11-17 15:51:38 +00:00
parent e0ddea839d
commit d30d3624bf
No known key found for this signature in database
GPG key ID: B413E0EF113D4ABF
1 changed files with 5 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
docs.md
View file

@ -1,14 +1,14 @@
# Documentation Workflow # Documentation Workflow
* [Install Hatch](https://hatch.pypa.io/latest/install/) * Ensure you're inside a *Python 3.10+* virtual environment
* Run the live-reload server using `hatch run docs:serve` from the project root * Run the live-reload server using `mkdocs serve` from the project root
* Create new pages by adding new directories and Markdown files inside `docs/*` * Create new pages by adding new directories and Markdown files inside `docs/*`
## Commands ## Commands
- `hatch run docs:serve` - Start the live-reloading docs server. - `mkdocs serve` - Start the live-reloading docs server.
- `hatch run docs:build` - Build the documentation site. - `mkdocs build` - Build the documentation site.
- `hatch run docs:help` - Print help message and exit. - `mkdocs -h` - Print help message and exit.
## Project layout ## Project layout