📝 Set up Githup pages with docsify

📝 Set up HTML-from-markdown website using docsify 🚚 Move /assets into /docs ✏️ Add dependencies to CONTRIBUTING.md 🎨 Change General Assumptions items from headers to a list, add download link beneath title 🔥 Remove Jekyll
rubiefawn · Sep 8, 2019 · f4fe58e · f4fe58e
1 parent 568cc9b
commit f4fe58e
Show file tree

Hide file tree

Showing 10 changed files with 113 additions and 45 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -1,3 +1,10 @@
+### Dependencies
+- [Twemoji](https://github.com/twitter/twemoji)
+- [docsify](https://docsify.js.org/#/?id=docsify)
+- [docsify full text search](https://docsify.js.org/#/plugins?id=full-text-search)
+- [docsify-plugin-flexible-alerts](https://github.com/zanfab/docsify-plugin-flexible-alerts)
+- [docsify-tabs](https://github.com/jhildenbiddle/docsify-tabs)
+
 ### Git Commit Messages
 
 - Use the present tense ("Add feature" not "Added feature")

diff --git a/README.md b/README.md
@@ -1,4 +1,4 @@
-# ![Dromissium logo](assets/icon.svg) Dromissium
+# ![Dromissium logo](/assets/icon.svg) Dromissium
 [![Current release](https://img.shields.io/github/v/release/iansannar/dromissium?include_prereleases&logo=Adobe-Acrobat-Reader&logoColor=white)](https://github.com/iansannar/dromissium/releases)
 ![Overall downloads on Github](https://img.shields.io/github/downloads/iansannar/dromissium/total)
 [![Last commit on Github](https://img.shields.io/github/last-commit/iansannar/dromissium?logo=Github&logoColor=white)](https://github.com/iansannar/dromissium/commits/master)
@@ -7,3 +7,4 @@
 A table-top roleplaying game with simple underlying rules, allowing easy DIY expansion and modularity for the Storyteller and ease of understanding for the new player.
 
 Race homebrew guide: http://bit.ly/homebrew-race
+
diff --git a/docs/.nojekyll b/docs/.nojekyll
diff --git a/docs/_config.yml b/docs/_config.yml
diff --git a/docs/assets/favicon.png b/docs/assets/favicon.png
diff --git a/assets/icon-dark.svg → docs/assets/icon-dark.svg b/assets/icon-dark.svg → docs/assets/icon-dark.svg
diff --git a/assets/icon.svg → docs/assets/icon.svg b/assets/icon.svg → docs/assets/icon.svg
diff --git a/assets/logo.svg → docs/assets/logo.svg b/assets/logo.svg → docs/assets/logo.svg
diff --git a/core.md → docs/core.md b/core.md → docs/core.md
diff --git a/docs/index.html b/docs/index.html
@@ -0,0 +1,49 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+	<meta charset="UTF-8">
+	<title>Dromissium</title>
+	<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
+	<meta name="description" content="Dromissium TTRPG Online Rulebook">
+	<meta name="viewport" content="width=device-width, user-scalable=no, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0">
+	<link rel="stylesheet" href="//unpkg.com/docsify/themes/vue.css">
+	<link rel="icon" href="assets/favicon.png">
+	<style>
+		:root {
+			--docsifytabs-tab-highlight-color: grey;
+		}
+</style>
+</head>
+<body>
+	<div id="app"></div>
+	<script>
+		window.$docsify = {
+			homepage: 'core.md',
+			name: 'Dromissium',
+			relativePath: true,
+			maxLevel: 3,
+
+			search: {
+				hideOtherSidebarContent: true,
+				maxAge: 86400000,
+				paths: [ '/' ],
+				placeholder: 'Search',
+				noData: 'No Results.'
+			},
+
+			tabs: {
+				persist: true,
+				sync: true,
+				theme: 'classic',
+				tabComments: true,
+				tabHeadings: true
+			}
+		}
+	</script>
+	<script src="//unpkg.com/docsify/lib/docsify.min.js"></script>
+	<!-- plugins -->
+	<script src="//unpkg.com/docsify/lib/plugins/search.min.js"></script>
+	<script src="https://unpkg.com/docsify-plugin-flexible-alerts"></script>
+	<script src="https://cdn.jsdelivr.net/npm/docsify-tabs@1"></script>
+</body>
+</html>