From 3a3af6ab10c029a991e41eda1f6e2aa1e97e0c3d Mon Sep 17 00:00:00 2001 From: Lucien Greathouse Date: Sun, 1 Apr 2018 23:35:18 -0700 Subject: [PATCH] Introduce mkdocs documentation --- docs/index.md | 6 ++++++ docs/requirements.txt | 3 +++ mkdocs.yml | 20 ++++++++++++++++++++ 3 files changed, 29 insertions(+) create mode 100644 docs/index.md create mode 100644 docs/requirements.txt create mode 100644 mkdocs.yml diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 00000000..a3319d83 --- /dev/null +++ b/docs/index.md @@ -0,0 +1,6 @@ +# Home +This is the documentation home for Rojo. + +**Rojo** is a flexible multi-tool designed for creating robust Roblox projects. + +This documentation is a work in progress, and is incomplete. \ No newline at end of file diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 00000000..51b61b75 --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1,3 @@ +mkdocs +mkdocs-material +pymdown-extensions \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 00000000..10529937 --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,20 @@ +site_name: Rojo Documentation +site_url: https://lpghatguy.github.io/rojo/ +repo_name: LPGhatguy/rojo +repo_url: https://github.com/LPGhatguy/rojo + +theme: + name: material + palette: + primary: 'Red' + accent: 'Red' + +pages: + - Home: index.md + +markdown_extensions: + - admonition + - codehilite: + guess_lang: false + - toc: + permalink: true \ No newline at end of file