mkdocs: add page (#8759)
This commit is contained in:
20
pages/common/mkdocs.md
Normal file
20
pages/common/mkdocs.md
Normal 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`
|
Reference in New Issue
Block a user