Python mkdocs: Difference between revisions
From wikinotes
(Created page with "Build static html documentation websites. = Documentation = <blockquote> {| class="wikitable" |- | github || https://github.com/mkdocs/mkdocs/ |- | home || https://www.mkdocs...") |
No edit summary |
||
| Line 11: | Line 11: | ||
|} | |} | ||
</blockquote><!-- Documentation --> | </blockquote><!-- Documentation --> | ||
= Install = | |||
<blockquote> | |||
<syntaxhighlight lang="bash"> | |||
pip install --user mkdocs | |||
</syntaxhighlight> | |||
</blockquote><!-- Install --> | |||
= Usage = | |||
<blockquote> | |||
<syntaxhighlight lang="bash"> | |||
mkdocs new my-project # create a new project dir | |||
mkdocs serve # dev server on localhost | |||
</syntaxhighlight> | |||
</blockquote><!-- Usage --> | |||
Latest revision as of 14:34, 17 April 2022
Build static html documentation websites.
Documentation
github https://github.com/mkdocs/mkdocs/ home https://www.mkdocs.org/
Install
pip install --user mkdocs
Usage
mkdocs new my-project # create a new project dir mkdocs serve # dev server on localhost
