From 3d2a12b82b93377e31d7ad8ce032347d9e98b305 Mon Sep 17 00:00:00 2001 From: Simon M Date: Thu, 3 Oct 2019 13:20:50 +0200 Subject: [PATCH] Rework sidebar (#65) * Add 'Menus' category Adds the menus: My library, Library updates, Recently read, Catalogues, Extensions and Download queue. * Rework sidebar * Add 'Menus' category (#63) Adds the menus: My library, Library updates, Recently read, Catalogues, Extensions and Download queue. * Improve MaterialIcon.vue (#66) * Update style on MaterialIcon * Update a few descriptions * Add guide for No results when searching (#68) * Reader guide improvements (#67) * site enhancements * Improve Reader guide * fix badge position * fix badge position 2 * modify page transition description * small changes * review changes * Improve Backup guide (+ small changes) (#69) * Rework sidebar --- src/.vuepress/config.js | 14 ++- src/.vuepress/config/nav.js | 111 ++++-------------- src/.vuepress/config/sidebar/contribution.js | 23 ++++ src/.vuepress/config/sidebar/extensions.js | 19 +++ src/.vuepress/config/sidebar/faq.js | 24 ++++ .../config/{sidebar.js => sidebar/guides.js} | 37 ++---- src/help/README.md | 13 ++ src/help/contribution.md | 24 ++++ 8 files changed, 149 insertions(+), 116 deletions(-) create mode 100644 src/.vuepress/config/sidebar/contribution.js create mode 100644 src/.vuepress/config/sidebar/extensions.js create mode 100644 src/.vuepress/config/sidebar/faq.js rename src/.vuepress/config/{sidebar.js => sidebar/guides.js} (70%) create mode 100644 src/help/README.md create mode 100644 src/help/contribution.md diff --git a/src/.vuepress/config.js b/src/.vuepress/config.js index 12fe9cb2..9348f06f 100644 --- a/src/.vuepress/config.js +++ b/src/.vuepress/config.js @@ -13,13 +13,21 @@ module.exports = { docsDir: 'src', editLinks: true, nav: require('./config/nav'), - sidebar: require('./config/sidebar'), + sidebar: { + '/help/guides/': require('./config/sidebar/guides'), + '/help/faq/': require('./config/sidebar/faq'), + '/help/contribution': require('./config/sidebar/contribution'), + '/extensions': require('./config/sidebar/extensions') + }, lastUpdated: 'Last Updated' }, plugins: require('./config/plugins'), extraWatchFiles: [ '.vuepress/config/nav.js', - '.vuepress/config/sidebar.js', - '.vuepress/config/plugins.js' + '.vuepress/config/plugins.js', + '.vuepress/config/sidebar/guides.js', + '.vuepress/config/sidebar/faq.js', + '.vuepress/config/sidebar/contribution.js', + '.vuepress/config/sidebar/extensions.js' ] } diff --git a/src/.vuepress/config/nav.js b/src/.vuepress/config/nav.js index 87bbbe96..7bf402c6 100644 --- a/src/.vuepress/config/nav.js +++ b/src/.vuepress/config/nav.js @@ -1,9 +1,10 @@ module.exports = [ { text: 'Need help?', + link: '/help/', items: [ { - text: 'General', + text: 'Frequently Asked Questions', items: [ { text: 'Application', @@ -15,104 +16,38 @@ module.exports = [ } ] }, + { + text: 'Guides', + items: [ + { + text: 'General', + link: '/help/guides/getting-started' + }, + { + text: 'Menus', + link: '/help/guides/my-library' + }, + { + text: 'Settings', + link: '/help/guides/general' + } + ] + }, { text: 'Contribution', items: [ { text: 'How can I help?', - link: '/help/faq/how-can-i-help' - } - ] - } - ] - }, - { - text: 'Guides', - items: [ - { - text: 'General', - items: [ - { - text: 'Getting started', - link: '/help/guides/getting-started' - }, - { - text: 'Reading local manga', - link: '/help/guides/reading-local-manga' - }, - { - text: 'Source problems', - link: '/help/guides/source-problems' - }, - { - text: 'Categories', - link: '/help/guides/categories' - }, - { - text: 'Library filters', - link: '/help/guides/library-filters' - }, - { - text: 'Source migration', - link: '/help/guides/source-migration' + link: '/help/contribution' } ] }, { - text: 'Menus', + text: 'Available extensions', items: [ { - text: 'My library', - link: '/help/guides/my-library' - }, - { - text: 'Library updates', - link: '/help/guides/library-updates' - }, - { - text: 'Recently read', - link: '/help/guides/recently-read' - }, - { - text: 'Catalogues', - link: '/help/guides/catalogues' - }, - { - text: 'Extensions', - link: '/help/guides/extensions' - }, - { - text: 'Download queue', - link: '/help/guides/download-queue' - } - ] - }, - { - text: 'Settings', - items: [ - { - text: 'General', - link: '/help/guides/general' - }, - { - text: 'Reader', - link: '/help/guides/reader' - }, - { - text: 'Downloads', - link: '/help/guides/downloads' - }, - { - text: 'Tracking', - link: '/help/guides/tracking' - }, - { - text: 'Backup', - link: '/help/guides/backup' - }, - { - text: 'Advanced', - link: '/help/guides/advanced' + text: 'List', + link: '/extensions/' } ] } diff --git a/src/.vuepress/config/sidebar/contribution.js b/src/.vuepress/config/sidebar/contribution.js new file mode 100644 index 00000000..acfc8e8a --- /dev/null +++ b/src/.vuepress/config/sidebar/contribution.js @@ -0,0 +1,23 @@ +module.exports = [ + '/', + { + title: 'Contribution', + collapsable: false, + sidebarDepth: 1, + children: [ + '/help/contribution' + ] + }, + { + title: 'Frequently Asked Questions', + path: '/help/faq/application', + }, + { + title: 'Guides', + path: '/help/guides/getting-started', + }, + { + title: 'Available extensions', + path: '/extensions/' + } +]; diff --git a/src/.vuepress/config/sidebar/extensions.js b/src/.vuepress/config/sidebar/extensions.js new file mode 100644 index 00000000..bd92baee --- /dev/null +++ b/src/.vuepress/config/sidebar/extensions.js @@ -0,0 +1,19 @@ +module.exports = [ + '/', + { + title: 'Available extensions', + path: '/extensions/' + }, + { + title: 'Frequently Asked Questions', + path: '/help/faq/application', + }, + { + title: 'Guides', + path: '/help/guides/getting-started', + }, + { + title: 'Contribution', + path: '/help/contribution' + } +]; diff --git a/src/.vuepress/config/sidebar/faq.js b/src/.vuepress/config/sidebar/faq.js new file mode 100644 index 00000000..fbf6730a --- /dev/null +++ b/src/.vuepress/config/sidebar/faq.js @@ -0,0 +1,24 @@ +module.exports = [ + '/', + { + title: 'Frequently Asked Questions', + collapsable: false, + sidebarDepth: 1, + children: [ + '/help/faq/application', + '/help/faq/extensions' + ] + }, + { + title: 'Guides', + path: '/help/guides/getting-started', + }, + { + title: 'Contribution', + path: '/help/contribution' + }, + { + title: 'Available extensions', + path: '/extensions/' + } +]; diff --git a/src/.vuepress/config/sidebar.js b/src/.vuepress/config/sidebar/guides.js similarity index 70% rename from src/.vuepress/config/sidebar.js rename to src/.vuepress/config/sidebar/guides.js index 10853729..bd5004dd 100644 --- a/src/.vuepress/config/sidebar.js +++ b/src/.vuepress/config/sidebar/guides.js @@ -2,7 +2,7 @@ module.exports = [ '/', { title: 'Guides', - path: '/help/guides/', + collapsable: false, sidebarDepth: 2, children: [ { @@ -41,34 +41,21 @@ module.exports = [ '/help/guides/downloads', '/help/guides/tracking', '/help/guides/backup', - '/help/guides/advanced' + '/help/guides/advanced', ] - } + }, ] }, { title: 'Frequently Asked Questions', - path: '/help/faq/', - sidebarDepth: 2, - children: [ - { - title: 'General', - collapsable: false, - sidebarDepth: 2, - children: [ - '/help/faq/application', - '/help/faq/extensions' - ] - }, - { - title: 'Contribution', - collapsable: false, - sidebarDepth: 2, - children: [ - '/help/faq/how-can-i-help' - ] - } - ] + path: '/help/faq/application', }, - '/extensions/' + { + title: 'Contribution', + path: '/help/contribution' + }, + { + title: 'Available extensions', + path: '/extensions/' + } ]; diff --git a/src/help/README.md b/src/help/README.md new file mode 100644 index 00000000..d88d5b2e --- /dev/null +++ b/src/help/README.md @@ -0,0 +1,13 @@ +--- +title: Help +lang: en-US +sidebar: false +--- + +# Help + +Choose between [guides](guides/general/) and [frequently asked questions](faq/application/). + +::: tip +Help us expand this page by clicking [here](https://github.com/tachiyomiorg/website/edit/master/src/help/README.md) +::: diff --git a/src/help/contribution.md b/src/help/contribution.md new file mode 100644 index 00000000..cef93727 --- /dev/null +++ b/src/help/contribution.md @@ -0,0 +1,24 @@ +--- +title: How can I help? +lang: en-US +--- + +# How can I help? +:construction: :construction_worker_man: W.I.P. Description, help us improve through [here](https://github.com/tachiyomiorg/website/edit/master/src/help/faq/how-can-i-help.md)! + +## GitHub +:construction: :construction_worker_man: W.I.P. + +## Translation + +**The project is available at [https://hosted.weblate.org/engage/tachiyomi/](https://hosted.weblate.org/engage/tachiyomi/)** +(direct [https://hosted.weblate.org/projects/tachiyomi/strings/](https://hosted.weblate.org/projects/tachiyomi/strings/)) + +The translators guide can be found at [https://docs.weblate.org/en/latest/user/index.html](https://docs.weblate.org/en/latest/user/index.html). Notice also: +* [https://docs.weblate.org/en/latest/user/profile.html#secondary-languages](https://docs.weblate.org/en/latest/user/profile.html#secondary-languages) +* [https://docs.weblate.org/en/latest/user/profile.html#subscriptions](https://docs.weblate.org/en/latest/user/profile.html#subscriptions) +* [https://docs.weblate.org/en/latest/user/translating.html#glossary](https://docs.weblate.org/en/latest/user/translating.html#glossary) + +*** + +[![Translation status](https://hosted.weblate.org/widgets/tachiyomi/-/multi-auto.svg)](https://hosted.weblate.org/engage/tachiyomi/?utm_source=widget)