mirror of https://github.com/CrimsonTome/tldr.git
mkdocs: add page (#8759)
parent
70a18ec1f9
commit
83d8e57068
|
@ -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`
|
Loading…
Reference in New Issue