From 83d8e570684eb912921ec4d2cbfe4b68c2cb88c3 Mon Sep 17 00:00:00 2001 From: Austin Date: Thu, 6 Oct 2022 15:53:50 +0200 Subject: [PATCH] mkdocs: add page (#8759) --- pages/common/mkdocs.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) create mode 100644 pages/common/mkdocs.md diff --git a/pages/common/mkdocs.md b/pages/common/mkdocs.md new file mode 100644 index 000000000..2aa9921d2 --- /dev/null +++ b/pages/common/mkdocs.md @@ -0,0 +1,20 @@ +# mkdocs + +> Project documentation with Markdown. +> More information: . + +- Create a new mkdocs project: + +`mkdocs new {{project_name}}` + +- Serve the project in the current directory using the mkdocs dev-server: + +`mkdocs serve` + +- Build the documentation in the current directory: + +`mkdocs build` + +- Deploy the documentation in the current directory to GitHub pages: + +`mkdocs gh-deploy`