From 72c47caeca37c626613abe5d7b56c05b8b608001 Mon Sep 17 00:00:00 2001 From: Blake DeMarcy Date: Mon, 17 Apr 2017 18:39:28 -0500 Subject: [PATCH] documentation and shit --- documentation/{ERRORS.md => docs/errors.md} | 0 documentation/docs/index.md | 17 +++++++++++++++++ .../{VALIDATION.md => docs/validation.md} | 0 documentation/mkdocs.yml | 1 + 4 files changed, 18 insertions(+) rename documentation/{ERRORS.md => docs/errors.md} (100%) create mode 100644 documentation/docs/index.md rename documentation/{VALIDATION.md => docs/validation.md} (100%) create mode 100644 documentation/mkdocs.yml diff --git a/documentation/ERRORS.md b/documentation/docs/errors.md similarity index 100% rename from documentation/ERRORS.md rename to documentation/docs/errors.md diff --git a/documentation/docs/index.md b/documentation/docs/index.md new file mode 100644 index 0000000..da37213 --- /dev/null +++ b/documentation/docs/index.md @@ -0,0 +1,17 @@ +# Welcome to MkDocs + +For full documentation visit [mkdocs.org](http://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/documentation/VALIDATION.md b/documentation/docs/validation.md similarity index 100% rename from documentation/VALIDATION.md rename to documentation/docs/validation.md diff --git a/documentation/mkdocs.yml b/documentation/mkdocs.yml new file mode 100644 index 0000000..c97182f --- /dev/null +++ b/documentation/mkdocs.yml @@ -0,0 +1 @@ +site_name: My Docs