mirror of
https://github.com/TGITS/fun-with-mkdocs.git
synced 2026-05-06 05:22:31 +02:00
20 lines
522 B
Markdown
20 lines
522 B
Markdown
# Fun with MkDocs
|
|
|
|
The full documentation is available at [mkdocs.org](https://www.mkdocs.org).
|
|
|
|
## Quick Cheatsheet
|
|
|
|
### Commands
|
|
|
|
* `mkdocs new [dir-name]` - Create a new project.
|
|
* `mkdocs serve` - Start the live-reloading docs server.
|
|
* `mkdocs build` - Build the documentation site.
|
|
* `mkdocs -h` - Print help message and exit.
|
|
|
|
### Project layout
|
|
|
|
mkdocs.yml # The configuration file.
|
|
docs/
|
|
index.md # The documentation homepage.
|
|
... # Other markdown pages, images and other files.
|