From 1f20019d57d4d50bbf4fdb2178ce5ae8366252a9 Mon Sep 17 00:00:00 2001 From: pyr0ball Date: Mon, 1 Jul 2019 13:48:10 -0700 Subject: [PATCH] Added mkdocs for readthedocs integration --- docs/index.md | 17 +++++++++++++++++ mkdocs.yml | 1 + 2 files changed, 18 insertions(+) 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/mkdocs.yml b/mkdocs.yml new file mode 100644 index 0000000..49c5f9a --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1 @@ +site_name: Pyr0-Piezo