mkdocs setup
This commit is contained in:
@@ -0,0 +1,2 @@
|
|||||||
|
site_name: My Docs
|
||||||
|
docs_dir: pages
|
||||||
@@ -0,0 +1,17 @@
|
|||||||
|
# Welcome to MkDocs
|
||||||
|
|
||||||
|
For full documentation visit [mkdocs.org](https://mkdocs.org).
|
||||||
|
|
||||||
|
## Commands
|
||||||
|
|
||||||
|
* `mkdocs new [dir-name]` - Create a new project.
|
||||||
|
* `mkdocs serve` - Start the live-reloading docs server.
|
||||||
|
* `mkdocs build` - Build the documentation site.
|
||||||
|
* `mkdocs help` - Print this help message.
|
||||||
|
|
||||||
|
## Project layout
|
||||||
|
|
||||||
|
mkdocs.yml # The configuration file.
|
||||||
|
docs/
|
||||||
|
index.md # The documentation homepage.
|
||||||
|
... # Other markdown pages, images and other files.
|
||||||
@@ -1,2 +1,4 @@
|
|||||||
-e .
|
-e .
|
||||||
pytest
|
pytest
|
||||||
|
mkdocs==1.0.4
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user