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`