From 886823fb4f850e1660d3cb2ade3b5b21f99f8743 Mon Sep 17 00:00:00 2001 From: Ludovic Cartier Date: Tue, 15 Oct 2024 17:26:55 +0200 Subject: [PATCH] mkdocs - add how to --- docs/markdown/howto.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) create mode 100644 docs/markdown/howto.md diff --git a/docs/markdown/howto.md b/docs/markdown/howto.md new file mode 100644 index 0000000..96bfec3 --- /dev/null +++ b/docs/markdown/howto.md @@ -0,0 +1,20 @@ +categories: markdown +title: mkdocs - how to + +# Home + +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.