GitHub docs (#338)

3 years ago · 09d1f34f6c
11 changed files with 105 additions and 13 deletions
--- a/docs/assets/css/main.css
+++ b/docs/assets/css/main.css
@ -0,0 +1,3 @@
+:root {
+    --content-max-width                 : 100%;
+}
--- a/docs/assets/img/android-chrome-192x192.png
+++ b/docs/assets/img/android-chrome-192x192.png
--- a/docs/assets/img/android-chrome-512x512.png
+++ b/docs/assets/img/android-chrome-512x512.png
--- a/docs/assets/img/apple-touch-icon.png
+++ b/docs/assets/img/apple-touch-icon.png
--- a/docs/assets/img/favicon-16x16.png
+++ b/docs/assets/img/favicon-16x16.png
--- a/docs/assets/img/favicon-32x32.png
+++ b/docs/assets/img/favicon-32x32.png
--- a/docs/assets/img/favicon.ico
+++ b/docs/assets/img/favicon.ico
--- a/docs/assets/img/site.webmanifest
+++ b/docs/assets/img/site.webmanifest
@ -0,0 +1 @@
+{"name":"","short_name":"","icons":[{"src":"/android-chrome-192x192.png","sizes":"192x192","type":"image/png"},{"src":"/android-chrome-512x512.png","sizes":"512x512","type":"image/png"}],"theme_color":"#ffffff","background_color":"#ffffff","display":"standalone"}
--- a/docs/atoz.md
+++ b/docs/atoz.md
@ -55,7 +55,7 @@ To install and manage `node` as a local user we are going to use [Node Version M
 This command will download and install `nvm` and reload our shell.

 ```bash
-curl -sL https://raw.githubusercontent.com/nvm-sh/nvm/master/install.sh | sudo bash && source ~/.profile
+curl -sL https://raw.githubusercontent.com/nvm-sh/nvm/master/install.sh | bash && source ~/.profile
 ```

 This command will install the latest version of the v14 branch, which is the minimum required version for WeTTY.
@ -190,7 +190,7 @@ This command will generate the correct URL you need to visit after using the sta
 echo https://$(curl -s4 icanhazip.com):3000
 ```

-*Please make make a note of this URL now.*
+_Please make make a note of this URL now._

 ## Running WeTTY

@ -278,7 +278,7 @@ Here is the template `config.json` you need to use.

 **Note:** To be [validated json](https://codebeautify.org/jsonvalidator) the below json example should have the `// ...` comments removed. With all comments removed the example is valid json. They are in the example to help explain the options and won't stop wetty from loading if you leave them in place. Lines you do not need can be commented out but should be removed if you want the json to pass validation.

-```
+```json
  "ssh": {
        "user": "username", // default user to use when ssh-ing
        "host": "localhost", // Server to ssh to
@ -380,7 +380,7 @@ Press `ctrl` + `x` and then press `y` to save then press `enter` to confirm and

 ### Optional - Systemd service with config file

-Here is the example using our pseudo configuration file. All modifications to the start up of `wetty` will be done by editing the `~/.config/Wetty/config` file and then reloading the ` wetty.service`. 
+Here is the example using our pseudo configuration file. All modifications to the start up of `wetty` will be done by editing the `~/.config/Wetty/config` file and then reloading the `wetty.service`.

 Use `nano` to open the file for editing.

@ -392,7 +392,6 @@ The copy and paste this code.

 **Note:** This `ExecStart` assumes the location of your `config.json` to be `~/.config/wetty/config.json`. Please make sure you use the correct location for this file.

-
 ```bash
 [Unit]
 Description=wetty
@ -548,15 +547,15 @@ If you chose to not use a password to login in you should protect your instance

 With `yarn`:

-~~~bash
+```bash
 yarn global upgrade wetty --prefix ~/
-~~~
+```

 To update or downgrade to a specific version you use this command:

-~~~bash
+```bash
 yarn global add wetty@2.0.2 --prefix ~/
-~~~
+```

 Now restart your `wetty` service.

@ -566,17 +565,17 @@ The proper way to update NVM is to use git. The `.nvm` directory is a git repo.

 These commands will update NVM to the latest version of the script and load it to your shell.

-~~~bash
+```bash
 cd ~/.nvm
 git fetch --tags
 git checkout $(git describe --abbrev=0 --tags --match "v[0-9]*" $(git rev-list --tags --max-count=1))
 source ~/.nvm/nvm.sh
-~~~
+```

 ## Updating node

 You can use the same command you used to install it with `nvm`

-```
+```bash
 nvm install 14
 ```
--- a/docs/index.html
+++ b/docs/index.html
@ -0,0 +1,77 @@
+<!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
+      },
+      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)
+
			`@ -0,0 +1 @@`
			`{"name":"","short_name":"","icons":[{"src":"/android-chrome-192x192.png","sizes":"192x192","type":"image/png"},{"src":"/android-chrome-512x512.png","sizes":"512x512","type":"image/png"}],"theme_color":"#ffffff","background_color":"#ffffff","display":"standalone"}`