add docsify website generator for github pages

IDMIL · Oct 27, 2023 · 2222a28 · 2222a28
1 parent e653330
commit 2222a28
Show file tree

Hide file tree

Showing 7 changed files with 86 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -1,2 +1,7 @@
 # tstick-docs
-Repository for T-Stick documentation
+
+Repository for T-Stick documentation.
+
+Pages generated using Docsify.js
+
+To learn more about using Docsify, visit https://docsify.js.org.
diff --git a/docs/index.md → docs/.nojekyll b/docs/index.md → docs/.nojekyll
diff --git a/docs/Availability Modelling.md b/docs/Availability Modelling.md
@@ -2,7 +2,7 @@
 
 # Introduction
 
-sdvsv
+TBD
 
 # Model Parameters
 

diff --git a/docs/LICENSE b/docs/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 docsifyjs
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/docs/README.md b/docs/README.md
@@ -0,0 +1,5 @@
+# T-Stick Documentary
+
+The T-Stick is a DMI conceived by Joseph Malloch and D. Andrew Stewart at the Input Devices and Music Interaction Laboratory (IDMIL) at McGill University. It has been in development since 2006, has a relatively long history for a DMI, has multiple versions, several expert performers, and has an associated repertoire. More than 20 copies have been built unintended for commercial use. Nevertheless, it has been adopted by expert performers and composers as part of their musical practice including D. Andrew Stewart (Soprano user) and Fernando Rocha (Tenor user). It has appeared in dozens of public appearances in countries such as Canada, USA, Brazil, Italy, Norway, and Portugal.
+
+https://www.youtube.com/watch?v=BudSGA511pg
diff --git a/docs/_sidebar.md b/docs/_sidebar.md
@@ -0,0 +1,2 @@
+- [Read Me](README)
+- [Example Second Page](second-page)
diff --git a/docs/index.html b/docs/index.html
@@ -0,0 +1,51 @@
+<!DOCTYPE html>
+<html lang="en">
+
+<head>
+  <meta charset="utf-8">
+  <meta name="viewport"
+    content="width=device-width, initial-scale=1, minimum-scale=1.0, shrink-to-fit=no, viewport-fit=cover">
+
+  <!-- Replace with your own title and description. -->
+  <title>Awesome Docsify Site</title>
+  <meta name="description" content="An awesome docsify site for publishing some content on the web.">
+
+  <!-- Default Theme (see https://docsify.js.org/#/themes) -->
+  <link rel="stylesheet" href="//cdn.jsdelivr.net/npm/docsify@4/lib/themes/vue.css">
+
+</head>
+
+<body>
+  <div id="app"></div>
+
+  <script>
+    // Docsify Configuration (see https://docsify.js.org/#/configuration)
+    window.$docsify = {
+      name: 'Simple Docsify Template',
+
+      // Sidebar Configuration
+      auto2top: true,
+      loadSidebar: true,
+      maxLevel: 0,
+      // Set subMaxLevel to 0 to remove automatic display of page table of contents (TOC) in Sidebar
+      subMaxLevel: 3,
+
+      // Search Plugin Configuration
+      search: {
+        placeholder: 'Type to search',
+        noData: 'No matches found.',
+        // Headline depth, 1 - 6
+        depth: 2,
+      }
+    };
+  </script>
+
+  <!-- Required -->
+  <script src="https://cdn.jsdelivr.net/npm/docsify@4/lib/docsify.min.js"></script>
+
+  <!-- Recommended -->
+  <script src="https://cdn.jsdelivr.net/npm/docsify@4/lib/plugins/zoom-image.min.js"></script>
+  <script src="https://cdn.jsdelivr.net/npm/docsify@4/lib/plugins/search.js"></script>
+
+</body>
+</html>
-Original file line number
+Diff line change
@@ Expand Up / @@ -2,7 +2,7 @@ @@
     # Introduction
-    sdvsv
+    TBD
     # Model Parameters
@@ Expand Down @@
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		- [Read Me](README)
		- [Example Second Page](second-page)