From 7e3a4855d84701162202a41ba7e292bede3bd135 Mon Sep 17 00:00:00 2001 From: Kristjan Komlosi Date: Sat, 22 Jun 2019 23:18:07 +0200 Subject: [PATCH] MkDocs initialization and RTFD.io integration --- docs/index.md | 17 +++++++++++++++++ docs/mkdocs.yml | 4 +--- mkdocs.yml | 1 + 3 files changed, 19 insertions(+), 3 deletions(-) create mode 100644 docs/index.md create mode 100644 mkdocs.yml diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..d388039 --- /dev/null +++ b/docs/index.md @@ -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. diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index de0ce52..c97182f 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -1,3 +1 @@ -nav: - - Build guide: 'build.md' - - Development-stable dependencies: 'dependencies.md' +site_name: My Docs diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 0000000..c97182f --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1 @@ +site_name: My Docs