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
This commit is contained in:
Simon M 2019-10-03 13:20:50 +02:00 committed by GitHub
parent ea3625bd04
commit 3d2a12b82b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
8 changed files with 149 additions and 116 deletions

View File

@ -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'
]
}

View File

@ -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: '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'
}
]
},
{
text: 'Menus',
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',
link: '/help/guides/general'
}
]
},
{
text: 'Settings',
text: 'Contribution',
items: [
{
text: 'General',
link: '/help/guides/general'
text: 'How can I help?',
link: '/help/contribution'
}
]
},
{
text: 'Reader',
link: '/help/guides/reader'
},
text: 'Available extensions',
items: [
{
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/'
}
]
}

View File

@ -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/'
}
];

View File

@ -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'
}
];

View File

@ -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/'
}
];

View File

@ -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'
]
path: '/help/faq/application',
},
{
title: 'Contribution',
collapsable: false,
sidebarDepth: 2,
children: [
'/help/faq/how-can-i-help'
]
}
]
path: '/help/contribution'
},
'/extensions/'
{
title: 'Available extensions',
path: '/extensions/'
}
];

13
src/help/README.md Normal file
View File

@ -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)
:::

24
src/help/contribution.md Normal file
View File

@ -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)