MkDocs initialization and RTFD.io integration

This commit is contained in:
Kristjan Komlosi
2019-06-22 23:18:07 +02:00
parent 41ae988562
commit 7e3a4855d8
3 changed files with 19 additions and 3 deletions

17
docs/index.md Normal file
View File

@@ -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.

View File

@@ -1,3 +1 @@
nav:
- Build guide: 'build.md'
- Development-stable dependencies: 'dependencies.md'
site_name: My Docs