diff options
author | Valentin Popov <valentin@popov.link> | 2024-02-06 01:26:50 +0300 |
---|---|---|
committer | Valentin Popov <valentin@popov.link> | 2024-02-06 01:26:50 +0300 |
commit | 3d48cd3f81164bbfc1a755dc1d4a9a02f98c8ddd (patch) | |
tree | 5904e98f11a5733901aa39751a17425bb5281eb8 /docs/index.md | |
parent | 78d6eca33641515993213ed912fd22a019be7f14 (diff) | |
download | fparkan-3d48cd3f81164bbfc1a755dc1d4a9a02f98c8ddd.tar.xz fparkan-3d48cd3f81164bbfc1a755dc1d4a9a02f98c8ddd.zip |
Initial MkDocs
Diffstat (limited to 'docs/index.md')
-rw-r--r-- | docs/index.md | 17 |
1 files changed, 17 insertions, 0 deletions
diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..000ea34 --- /dev/null +++ b/docs/index.md @@ -0,0 +1,17 @@ +# Welcome to 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. |