mirror of
https://github.com/tldr-pages/tldr.git
synced 2025-04-29 23:24:55 +02:00
mkdocs: add page (#8759)
This commit is contained in:
parent
70a18ec1f9
commit
83d8e57068
1 changed files with 20 additions and 0 deletions
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`
|
Loading…
Add table
Reference in a new issue