setup: mkdocs initial setup

This commit is contained in:
eggy 2020-09-11 18:22:42 -04:00
commit cc7d3113f9
2 changed files with 18 additions and 0 deletions

17
docs/index.md Normal file
View File

@ -0,0 +1,17 @@
# Welcome to MkDocs
For full documentation visit [mkdocs.org](https://www.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 -h` - Print help message and exit.
## Project layout
mkdocs.yml # The configuration file.
docs/
index.md # The documentation homepage.
... # Other markdown pages, images and other files.

1
mkdocs.yml Normal file
View File

@ -0,0 +1 @@
site_name: My Docs