mkdocs: add page (#8759)

pull/1/head
Austin 2022-10-06 15:53:50 +02:00 committed by GitHub
parent 70a18ec1f9
commit 83d8e57068
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 20 additions and 0 deletions

20
pages/common/mkdocs.md Normal file
View File

@ -0,0 +1,20 @@
# mkdocs
> Project documentation with Markdown.
> More information: <https://www.mkdocs.org>.
- 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`