diff --git a/docs/README b/docs/README new file mode 100644 index 000000000..f48703c5b --- /dev/null +++ b/docs/README @@ -0,0 +1,27 @@ +# Welcome to MkDocs + +Install MkDocs - https://www.mkdocs.org/#installing-mkdocs + +For full documentation visit [mkdocs.org](https://www.mkdocs.org). + +## 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. + +Useful links: + +- Material for MkDocs +https://squidfunk.github.io/mkdocs-material/ + +- Admonitions (tip, warning, info boxes) +https://squidfunk.github.io/mkdocs-material/reference/admonitions/