From f99262f3efcfa79f1add91f4e23e512828a71c62 Mon Sep 17 00:00:00 2001 From: Soitora Date: Mon, 11 May 2020 19:50:31 +0200 Subject: [PATCH] Add a Help entry point (#183) * Initial work * Add community md icons * Allow search to be hidden from frontmatter * Update Help.vue * Adjust README to fit new Help.vue * More stuffs * Linting * Try fixing valid v-else * Missed the actual error * Can't resolve "vue-material-design-icons/GitHub.vue" fix? * Force the page to ignore sidebar padding --- package-lock.json | 5 + package.json | 1 + src/.vuepress/components/Help.vue | 261 ++++++++++++++++++++++ src/.vuepress/config.js | 1 + src/.vuepress/config/nav.js | 39 +--- src/.vuepress/enhanceApp.js | 1 + src/.vuepress/theme/components/Navbar.vue | 3 +- src/help/README.md | 48 +++- 8 files changed, 316 insertions(+), 43 deletions(-) create mode 100644 src/.vuepress/components/Help.vue diff --git a/package-lock.json b/package-lock.json index 4397dd37..57abc2ca 100644 --- a/package-lock.json +++ b/package-lock.json @@ -14567,6 +14567,11 @@ "vue-style-loader": "^4.1.0" } }, + "vue-material-design-icons": { + "version": "4.6.0", + "resolved": "https://registry.npmjs.org/vue-material-design-icons/-/vue-material-design-icons-4.6.0.tgz", + "integrity": "sha512-b0Js/C4WHFnpcuH8goxl0bM7mjuSNClAYvsijUwfMfWXjW663ZvcQj3Int5H9rgRwZjPXPTJVxbFn+4sWJKMVA==" + }, "vue-router": { "version": "3.1.6", "resolved": "https://registry.npmjs.org/vue-router/-/vue-router-3.1.6.tgz", diff --git a/package.json b/package.json index a9fbfa2d..d5f4733c 100644 --- a/package.json +++ b/package.json @@ -34,6 +34,7 @@ "lodash.groupby": "^4.6.0", "lodash.sortby": "^4.7.0", "material-design-icons": "^3.0.1", + "vue-material-design-icons": "^4.6.0", "vue-sweetalert2": "^3.0.5", "vuepress-plugin-sitemap": "^2.3.1" } diff --git a/src/.vuepress/components/Help.vue b/src/.vuepress/components/Help.vue new file mode 100644 index 00000000..0f819dd9 --- /dev/null +++ b/src/.vuepress/components/Help.vue @@ -0,0 +1,261 @@ + + + + + diff --git a/src/.vuepress/config.js b/src/.vuepress/config.js index 536b74b9..97956ee5 100644 --- a/src/.vuepress/config.js +++ b/src/.vuepress/config.js @@ -28,6 +28,7 @@ module.exports = { repo: 'inorichi/tachiyomi', docsRepo: 'tachiyomiorg/website', docsDir: 'src', + smoothScroll: true, algolia: { apiKey: 'fc1c45b5a3835e1882cbbf0751dfe705', indexName: 'tachiyomi' diff --git a/src/.vuepress/config/nav.js b/src/.vuepress/config/nav.js index f6c9352a..07185b6f 100644 --- a/src/.vuepress/config/nav.js +++ b/src/.vuepress/config/nav.js @@ -1,40 +1,5 @@ module.exports = [ - { text: "FAQ", link: "/help/faq/" }, - { - text: "Guides", - items: [ - { - text: "Guides", - items: [ - { text: "Getting started", link: "/help/guides/getting-started/" }, - { text: "Source problems", link: "/help/guides/source-problems/" }, - { text: "Source migration", link: "/help/guides/source-migration/" }, - { text: "Creating backups", link: "/help/guides/creating-backups/" }, - { text: "Reading local manga", link: "/help/guides/reading-local-manga/" }, - { text: "Categories", link: "/help/guides/categories/" }, - { text: "Settings", link: "/help/guides/settings/" }, - ] - } - ], - }, - { text: "Forks", link: "/forks/" }, + { text: "Home", link: "/" }, + { text: "Help", link: "/help/" }, { text: "Extensions", link: "/extensions/" }, - { - text: "Links", - items: [ - { - text: "Community", - items: [ - { text: "Discord", link: "https://discord.gg/tachiyomi" }, - { text: "Reddit", link: "https://reddit.com/r/Tachiyomi" }, - ] - }, - { - text: "Sponsor", - items: [ - { text: "Ko-fi", link: "https://ko-fi.com/inorichi" }, - ] - }, - ] - }, ]; diff --git a/src/.vuepress/enhanceApp.js b/src/.vuepress/enhanceApp.js index ad8e50ec..b2fb6603 100644 --- a/src/.vuepress/enhanceApp.js +++ b/src/.vuepress/enhanceApp.js @@ -1,6 +1,7 @@ import './styles/fonts.styl' import './styles/animations.styl' import 'sweetalert2/dist/sweetalert2.min.css'; +import 'vue-material-design-icons/styles.css'; import { VueAgile } from 'vue-agile'; import VueSweetalert2 from 'vue-sweetalert2'; diff --git a/src/.vuepress/theme/components/Navbar.vue b/src/.vuepress/theme/components/Navbar.vue index 4fdd6028..f0d17bf6 100644 --- a/src/.vuepress/theme/components/Navbar.vue +++ b/src/.vuepress/theme/components/Navbar.vue @@ -26,8 +26,9 @@ 'max-width': linksWrapMaxWidth + 'px' } : {}" > +
diff --git a/src/help/README.md b/src/help/README.md index 2fe4ed61..759fb9b7 100644 --- a/src/help/README.md +++ b/src/help/README.md @@ -1,10 +1,48 @@ --- -title: Help -description: An overview of help pages you can access quickly. +layout: Help +title: Help center +description: From common questions to guides, find help for everything Tachiyomi. lang: en-US -sidebar: false +hideSearch: true +help: + - title: Application + description: Frequently asked questions + link: /help/faq/#application + faqApp: true + - title: Extensions + description: Frequently asked questions + link: /help/faq/#extensions + faqExt: true + - title: Guides + description: Extensive guides written for you + link: /help/guides/getting-started/ + guides: true + extensions: true + - title: Forks + description: Alternative versions + link: /forks/ + forks: true + - title: Contribution + description: Help contribute to the app + link: /help/contribution/ + contribution: true + - title: Discord + description: Primary communication platform + linkExt: https://discord.gg/tachiyomi + discord: true + - title: Reddit + description: Community forums + linkExt: https://reddit.com/r/Tachiyomi + reddit: true + - title: GitHub + description: Repository for the app + linkExt: https://github.com/inorichi/tachiyomi + github: true --- -# Help +# Help center -Choose between [guides](guides/getting-started/) and [frequently asked questions](faq/). +::: slot center +### Need help? We've got your back. +From common questions to guides, find help for everything Tachiyomi. +::: \ No newline at end of file