Add support to more guides (#20)

Add support to more guides

package-lock.json

@@ -1129,6 +1129,21 @@
         "lodash.throttle": "^4.1.1"
       }
     },
+    "@vuepress/plugin-back-to-top": {
+      "version": "1.1.0",
+      "resolved": "https://registry.npmjs.org/@vuepress/plugin-back-to-top/-/plugin-back-to-top-1.1.0.tgz",
+      "integrity": "sha512-UodMcqqSYERwoQkJQIwqEGxtyQGZMNo0YDfPGXXsIVJqesfeqgTSqfzuZZv/oCAahvG+EHtV4ZzKguls+cm1tA==",
+      "dev": true,
+      "requires": {
+        "lodash.debounce": "^4.0.8"
+      }
+    },
+    "@vuepress/plugin-google-analytics": {
+      "version": "1.1.0",
+      "resolved": "https://registry.npmjs.org/@vuepress/plugin-google-analytics/-/plugin-google-analytics-1.1.0.tgz",
+      "integrity": "sha512-dihyMDXWyPPGxvZge6Xz904ZAjhNcP2dzVbMa2rBvh9oPd6VD5M6mMw6NyNzHfm+LTFY0bTqOzuTFC1j7RnZnw==",
+      "dev": true
+    },
     "@vuepress/plugin-last-updated": {
       "version": "1.1.0",
       "resolved": "https://registry.npmjs.org/@vuepress/plugin-last-updated/-/plugin-last-updated-1.1.0.tgz",
@@ -4248,7 +4263,8 @@
         "ansi-regex": {
           "version": "2.1.1",
           "bundled": true,
-          "dev": true
+          "dev": true,
+          "optional": true
         },
         "aproba": {
           "version": "1.2.0",
@@ -4269,12 +4285,14 @@
         "balanced-match": {
           "version": "1.0.0",
           "bundled": true,
-          "dev": true
+          "dev": true,
+          "optional": true
         },
         "brace-expansion": {
           "version": "1.1.11",
           "bundled": true,
           "dev": true,
+          "optional": true,
           "requires": {
             "balanced-match": "^1.0.0",
             "concat-map": "0.0.1"
@@ -4289,17 +4307,20 @@
         "code-point-at": {
           "version": "1.1.0",
           "bundled": true,
-          "dev": true
+          "dev": true,
+          "optional": true
         },
         "concat-map": {
           "version": "0.0.1",
           "bundled": true,
-          "dev": true
+          "dev": true,
+          "optional": true
         },
         "console-control-strings": {
           "version": "1.1.0",
           "bundled": true,
-          "dev": true
+          "dev": true,
+          "optional": true
         },
         "core-util-is": {
           "version": "1.0.2",
@@ -4416,7 +4437,8 @@
         "inherits": {
           "version": "2.0.3",
           "bundled": true,
-          "dev": true
+          "dev": true,
+          "optional": true
         },
         "ini": {
           "version": "1.3.5",
@@ -4428,6 +4450,7 @@
           "version": "1.0.0",
           "bundled": true,
           "dev": true,
+          "optional": true,
           "requires": {
             "number-is-nan": "^1.0.0"
           }
@@ -4442,6 +4465,7 @@
           "version": "3.0.4",
           "bundled": true,
           "dev": true,
+          "optional": true,
           "requires": {
             "brace-expansion": "^1.1.7"
           }
@@ -4449,12 +4473,14 @@
         "minimist": {
           "version": "0.0.8",
           "bundled": true,
-          "dev": true
+          "dev": true,
+          "optional": true
         },
         "minipass": {
           "version": "2.3.5",
           "bundled": true,
           "dev": true,
+          "optional": true,
           "requires": {
             "safe-buffer": "^5.1.2",
             "yallist": "^3.0.0"
@@ -4473,6 +4499,7 @@
           "version": "0.5.1",
           "bundled": true,
           "dev": true,
+          "optional": true,
           "requires": {
             "minimist": "0.0.8"
           }
@@ -4553,7 +4580,8 @@
         "number-is-nan": {
           "version": "1.0.1",
           "bundled": true,
-          "dev": true
+          "dev": true,
+          "optional": true
         },
         "object-assign": {
           "version": "4.1.1",
@@ -4565,6 +4593,7 @@
           "version": "1.4.0",
           "bundled": true,
           "dev": true,
+          "optional": true,
           "requires": {
             "wrappy": "1"
           }
@@ -4650,7 +4679,8 @@
         "safe-buffer": {
           "version": "5.1.2",
           "bundled": true,
-          "dev": true
+          "dev": true,
+          "optional": true
         },
         "safer-buffer": {
           "version": "2.1.2",
@@ -4686,6 +4716,7 @@
           "version": "1.0.2",
           "bundled": true,
           "dev": true,
+          "optional": true,
           "requires": {
             "code-point-at": "^1.0.0",
             "is-fullwidth-code-point": "^1.0.0",
@@ -4705,6 +4736,7 @@
           "version": "3.0.1",
           "bundled": true,
           "dev": true,
+          "optional": true,
           "requires": {
             "ansi-regex": "^2.0.0"
           }
@@ -4748,12 +4780,14 @@
         "wrappy": {
           "version": "1.0.2",
           "bundled": true,
-          "dev": true
+          "dev": true,
+          "optional": true
         },
         "yallist": {
           "version": "3.0.3",
           "bundled": true,
-          "dev": true
+          "dev": true,
+          "optional": true
         }
       }
     },
@@ -6023,6 +6057,12 @@
       "integrity": "sha1-4j8/nE+Pvd6HJSnBBxhXoIblzO8=",
       "dev": true
     },
+    "lodash.debounce": {
+      "version": "4.0.8",
+      "resolved": "https://registry.npmjs.org/lodash.debounce/-/lodash.debounce-4.0.8.tgz",
+      "integrity": "sha1-gteb/zCmfEAF/9XiUVMArZyk168=",
+      "dev": true
+    },
     "lodash.groupby": {
       "version": "4.6.0",
       "resolved": "https://registry.npmjs.org/lodash.groupby/-/lodash.groupby-4.6.0.tgz",

src/.vuepress/config.js

@@ -8,7 +8,7 @@ module.exports = {
 		docsDir: 'src',
 		editLinks: true,
 		nav: [
-			{ text: 'Guide', link: '/help/guide/' },
+			{ text: 'Guides', link: '/help/guides/getting-started' },
 			{ text: 'FAQ', link: '/help/faq/' },
 			{ text: 'Extensions', link: '/extensions/' },
 			{ text: 'Wiki', link: 'https://github.com/inorichi/tachiyomi/wiki' },
@@ -17,11 +17,13 @@ module.exports = {
 		],
 		sidebar: [
 			'/',
-			'/help/guide/',
+			{
+				title: 'Guides',
+				children: ['/help/guides/getting-started', '/help/guides/reading-local-manga']
+			},
 			{
 				title: 'FAQ',
 				path: '/help/faq/',
-				collapsable: false,
 				children: ['/help/faq/application/', '/help/faq/extensions/']
 			},
 			'/extensions/'

src/README.md

@@ -3,7 +3,7 @@ home: true
 lang: en-US
 heroImage: /assets/media/hero.png
 actionText: Get Started →
-actionLink: /help/guide/
+actionLink: /help/guides/getting-started
 features:
     - title: Extensions
       details: Online reading from sources such as KissManga, MangaDex and more.

src/help/guides/reading-local-manga.md

@@ -0,0 +1,36 @@
+---
+title: Reading local manga
+lang: en-US
+---
+
+# Reading local manga
+
+Since `v0.5.0`, Tachiyomi supports local manga.
+
+You have to place your manga inside the folder `Tachiyomi/local` located in
+the root of your internal storage or external SD card, usually `/sdcard`
+and `/storage/18F5-2C11` (with different values).
+
+After that, they will be shown in the catalogue as a new source. **Remember to
+give the app disk permissions on Android 6.0 and higher**. If you add more
+chapters later you'll have to manually refresh the chapter list
+(by pulling down the list).
+
+Supported chapter formats are directories with pictures inside, ZIP/CBZ,
+RAR/CBR and EPUB. But expect better performance with directories and ZIP/CBZ.
+
+You can also place your chapters or manga in both storages and Tachiyomi
+will merge them. For example, with
+
+`/sdcard/Tachiyomi/local/my manga/ch1`
+
+and
+
+`/storage/18F5-2C11/Tachiyomi/local/my manga/ch2`
+
+the app will see two chapters in a single manga.
+
+The path to the folder (or archive) with images must contain both the
+manga title and the chapter name (as seen above).
+
+You can then access the manga in `Catalogues > Local manga`.