From 2c18e0e6b7b3f9a1121dd6a508610ab0f1fbecb4 Mon Sep 17 00:00:00 2001 From: Intelli Date: Wed, 30 Jan 2019 18:49:41 -0700 Subject: [PATCH] Added MkDocs support --- README.md | 2 ++ docs/index.md | 7 +++++++ mkdocs.yml | 3 +++ requirements.txt | 1 + 4 files changed, 13 insertions(+) create mode 100644 docs/index.md create mode 100644 mkdocs.yml create mode 100644 requirements.txt diff --git a/README.md b/README.md index 898f357..627e932 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,4 @@ # CoreProtect CoreProtect is a blazing fast data logging and anti-griefing tool for Minecraft servers. + +Documentation: [docs.coreprotect.net](http://docs.coreprotect.net). \ No newline at end of file diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..eb52933 --- /dev/null +++ b/docs/index.md @@ -0,0 +1,7 @@ +# Welcome to the CoreProtect Documentation + +For more information about CoreProtect, visit [coreprotect.net](http://coreprotect.net). + +## Getting Started + +This project is still under development, and is not yet ready for testing or contributions. \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 0000000..19a410e --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,3 @@ +site_name: CoreProtect Documentation +theme: readthedocs +repo_url: https://github.com/PlayPro/CoreProtect \ No newline at end of file diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..b854bca --- /dev/null +++ b/requirements.txt @@ -0,0 +1 @@ +mkdocs \ No newline at end of file