feature: use docsify to provide github-pages using the existing files in the docs folders.

4 years ago · 24c7b069f6
3 changed files with 95 additions and 0 deletions
--- a/docs/assets/css/main.css
+++ b/docs/assets/css/main.css
@ -0,0 +1,3 @@
+:root {
+    --content-max-width                 : 100%;
+}
--- a/docs/index.html
+++ b/docs/index.html
@ -0,0 +1,80 @@
+<!doctype html>
+<html lang="en">
+
+<head>
+  <meta charset="UTF-8">
+  <meta http-equiv="X-UA-Compatible" content="IE=edge">
+  <meta name="viewport"
+    content="width=device-width, initial-scale=1, minimum-scale=1.0, shrink-to-fit=no, viewport-fit=cover">
+  <meta name="description" content="WeTTY">
+  <title>WeTTY = Web + TTY</title>
+
+  <link rel="apple-touch-icon" sizes="180x180" href="assets/img/apple-touch-icon.png">
+  <link rel="icon" type="image/png" sizes="32x32" href="assets/img/favicon-32x32.png">
+  <link rel="icon" type="image/png" sizes="16x16" href="assets/img/favicon-16x16.png">
+  <link rel="manifest" href="assets/img/site.webmanifest">
+
+  <!-- Theme -->
+  <!-- <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/docsify-themeable/dist/css/theme-simple.css"> -->
+  <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/docsify-themeable/dist/css/theme-simple.css">
+  <link rel="stylesheet" href="assets/css/main.css">
+
+  <script src="https://cdn.jsdelivr.net/npm/docsify-edit-on-github"></script>
+</head>
+
+<body>
+  <div id="app">Please wait...</div>
+  <script>
+    window.$docsify = {
+      // GENERAL
+      // -----------------------------------------------------------------
+      name: 'WeTTY = Web + TTY',
+      repo: 'https://github.com/butlerx/wetty',
+      homepage: 'README.md',
+      loadSidebar: true,
+      loadSidebar: 'sidebar.md',
+      auto2top: true,
+      executeScript: true,
+      mergeNavbar: true,
+      maxLevel: 3,
+      subMaxLevel: 3,
+      // PLUGINS
+      // -----------------------------------------------------------------
+      plugins: [
+        EditOnGithubPlugin.create('https://github.com/butlerx/wetty/tree/master/docs/'),
+      ],
+      search: {
+        noData: {
+          '/': 'No results!'
+        },
+        paths: 'auto',
+        placeholder: {
+          '/': 'Search'
+        }
+      },
+      tabs: {
+        persist: true,      // default
+        sync: true,      // default
+        theme: 'classic', // default
+        tabComments: true,      // default
+        tabHeadings: true       // default
+      },
+      'flexible-alerts': {
+        style: 'flat'
+      },
+      themeable: {
+        readyTransition: true, // default
+        responsiveTables: true // default
+      }
+    };
+  </script>
+  <script src="https://cdn.jsdelivr.net/npm/docsify"></script>
+  <script src="https://cdn.jsdelivr.net/npm/docsify-tabs"></script>
+  <script src="https://cdn.jsdelivr.net/npm/docsify-copy-code"></script>
+  <script src="https://cdn.jsdelivr.net/npm/docsify-themeable"></script>
+  <script src="https://cdn.jsdelivr.net/npm/docsify/lib/plugins/search.min.js"></script>
+  <script src="https://cdn.jsdelivr.net/npm/docsify-prism"></script>
+  <script src="https://cdn.jsdelivr.net/npm/prismjs/plugins/autoloader/prism-autoloader.min.js"></script>
+</body>
+
+</html>
--- a/docs/sidebar.md
+++ b/docs/sidebar.md
@ -0,0 +1,12 @@
+- [README.md](README.md)
+- [Apache](apache.md)
+- [API](API.md)
+- [AtoZ](atoz.md)
+- [auto-login](auto-login.md)
+- [development](development.md)
+- [downloading-files](downloading-files.md)
+- [flags](flags.md)
+- [https](https.md)
+- [nginx](nginx.md)
+- [service](service.md)
+