[wip] Add deployment to Itch.io (requires PR)

docsifyjs/docsify#1372
grislyeye · Sep 12, 2020 · a1ba867 · a1ba867
1 parent 5787ee0
commit a1ba867
Show file tree

Hide file tree

Showing 13 changed files with 1,248 additions and 83 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,2 +1,3 @@
 node_modules
 *.log
+dist
diff --git a/README.md b/README.md
@@ -1,7 +1,25 @@
 # Three Meet
 
-**Three Meet** is a low-fantasy hack of the fifth edition of the world's most popular table-top roleplaying game (5E). It offers the following new features:
+**Three Meet** is a low-fantasy hack of the fifth edition of the world's most popular table-top roleplaying game (5E).
 
-## Consolidated Attributes
+This project has the following requirements:
 
-**Three Meet** consolidates confusing pair of ability scores (Strength/Constitution and Intelligence/Wisdom and Dexterity) for simplicity: **Cunning** (for rogues), **Strength** (for fighters) and **Wisdom** (for wizards and clerics), as well as a “wild card” attribute, Luck.
+  * [NPM](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm)
+  * [Butler](https://itch.io/docs/butler/installing.html)
+
+## Run
+
+Execute:
+
+```sh
+$ npm install
+$ npm start
+```
+
+## Deploy
+
+Execute:
+
+```sh
+$ npm run deploy
+```
diff --git a/book/README.md b/book/README.md
@@ -0,0 +1,3 @@
+# What is this?
+
+**Three Meet** is a low-fantasy hack of the fifth edition of the world's most popular table-top roleplaying game (5E).
diff --git a/book/_coverpage.md b/book/_coverpage.md
@@ -0,0 +1,3 @@
+# Three Meet
+
+A low fantasy 5E hack by R.G. Wood
diff --git a/book/_sidebar.md b/book/_sidebar.md
@@ -0,0 +1,2 @@
+* [What is this?](about.md)
+* [Design Notes](design-notes.md)
diff --git a/book/about.md b/book/about.md
@@ -0,0 +1,3 @@
+# What is this?
+
+**Three Meet** is a low-fantasy hack of the fifth edition of the world's most popular table-top roleplaying game (5E).
diff --git a/book/design-notes.md b/book/design-notes.md
@@ -0,0 +1,7 @@
+# Design Notes
+
+**Three Meet** offers the following new features:
+
+## Consolidated Ability Scores
+
+**Three Meet** consolidates confusing pair of ability scores (Strength/Constitution and Intelligence/Wisdom and Dexterity) for simplicity: **Cunning** (for rogues), **Stamina** (for fighters) and **Wisdom** (for wizards and clerics), as well as a “wild card” attribute, Luck.
diff --git a/index.html → book/index.html b/index.html → book/index.html
@@ -13,9 +13,13 @@
   <script>
     window.$docsify = {
       name: 'Three Meet',
-      repo: ''
+      coverpage: true,
+      loadSidebar: true,
+      subMaxLevel: 2,
+      search: 'auto'
     }
   </script>
-  <script src="node_modules/docsify/lib/docsify.min.js"></script>
+  <script src="node_modules/docsify/lib/docsify.js"></script>
+  <script src="node_modules/docsify/lib/plugins/search.min.js"></script>
 </body>
 </html>
diff --git a/book/package-lock.json b/book/package-lock.json
diff --git a/book/package.json b/book/package.json
@@ -0,0 +1,6 @@
+{
+  "dependencies": {
+    "docsify": "^4.11.6",
+    "docsify-pagination": "^2.6.0"
+  }
+}