From 2a35303acfffc23adb20a23fc9a032de9ba6ef12 Mon Sep 17 00:00:00 2001 From: Soitora Date: Tue, 18 Jul 2023 20:14:11 +0200 Subject: [PATCH] Cleanup --- .github/workflows/deploy.yml | 2 +- .markdownlint.json | 2 +- src/.vitepress/config.ts | 16 +-- src/docs/contribution.md | 50 ++++----- src/docs/faq/application/android-11+.md | 19 ++-- src/docs/faq/application/browse/index.md | 28 ++++-- .../browse/reading-with-local-source.md | 27 +++-- src/docs/faq/application/downloads.md | 47 +++++---- src/docs/faq/application/index.md | 27 ++--- src/docs/faq/application/library.md | 37 ++++--- src/docs/faq/application/reader.md | 18 +++- src/docs/faq/application/shizuku.md | 27 +++-- src/docs/faq/application/user-interface.md | 14 ++- src/docs/faq/extensions.md | 68 ++++++++----- src/docs/faq/general.md | 23 +++-- src/docs/faq/miscellaneous.md | 23 +++-- src/docs/guides/backups.md | 58 +++++------ src/docs/guides/categories.md | 42 ++++---- src/docs/guides/getting-started.md | 17 +++- src/docs/guides/img/TachiyomiAZ | 59 ----------- src/docs/guides/img/TachiyomiEH | 57 ----------- src/docs/guides/img/TachiyomiJ2K | 59 ----------- ...mage (1).png => guides_nav-edge-light.png} | Bin ... (3).png => guides_nav-kindlish-light.png} | Bin .../img/{image.png => guides_nav-l-light.png} | Bin ...ng => guides_nav-right-and-left-light.png} | Bin src/docs/guides/local-manga.md | 47 ++++++--- src/docs/guides/reader-settings.md | 3 +- src/docs/guides/source-migration.md | 95 +++++++----------- src/docs/guides/tracking.md | 40 ++++---- src/docs/guides/troubleshooting.md | 3 +- src/download.md | 10 +- src/extensions.md | 8 ++ src/forks/index.md | 9 +- src/forks/neko.md | 19 ++-- src/forks/tachiyomiaz.md | 36 +++---- src/forks/tachiyomij2k.md | 13 ++- src/forks/tachiyomisy.md | 15 +-- src/index.md | 1 - src/privacy.md | 30 ++++-- 40 files changed, 499 insertions(+), 550 deletions(-) delete mode 100644 src/docs/guides/img/TachiyomiAZ delete mode 100644 src/docs/guides/img/TachiyomiEH delete mode 100644 src/docs/guides/img/TachiyomiJ2K rename src/docs/guides/img/{image (1).png => guides_nav-edge-light.png} (100%) rename src/docs/guides/img/{image (3).png => guides_nav-kindlish-light.png} (100%) rename src/docs/guides/img/{image.png => guides_nav-l-light.png} (100%) rename src/docs/guides/img/{image (2).png => guides_nav-right-and-left-light.png} (100%) diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml index 7605a82a..f46dd16b 100644 --- a/.github/workflows/deploy.yml +++ b/.github/workflows/deploy.yml @@ -7,7 +7,7 @@ on: - v3-vitepress env: - VITE_BUILD: ${{ env.VITE_BUILD }} + VITE_BUILD: ${{ env.VITE_BUILD }} jobs: deploy: diff --git a/.markdownlint.json b/.markdownlint.json index 3c6c4242..12ccb3cf 100644 --- a/.markdownlint.json +++ b/.markdownlint.json @@ -1,5 +1,5 @@ { - "extends": "markdownlint/style/prettier", + "extends": "markdownlint/style/prettier", "list-marker-space": { "ul_multi": 3, "ul_single": 3 diff --git a/src/.vitepress/config.ts b/src/.vitepress/config.ts index 5ea24fac..0b81f300 100644 --- a/src/.vitepress/config.ts +++ b/src/.vitepress/config.ts @@ -118,23 +118,9 @@ function sidebarGuide() { { text: "Reader settings", link: "/docs/guides/reader-settings" }, ], }, - // { - // text: "Migrations", - // collapsed: false, - // items: [ - // { - // text: "Migration from VuePress", - // link: "/guide/migration-from-vuepress" - // }, - // { - // text: "Migration from VitePress 0.x", - // link: "/guide/migration-from-vitepress-0" - // } - // ] - // }, { text: "Contribution", - link: "/docs/tachiyomi/contribution", + link: "/docs/contribution", }, { text: "Download", diff --git a/src/docs/contribution.md b/src/docs/contribution.md index 9de412c4..aa32f186 100644 --- a/src/docs/contribution.md +++ b/src/docs/contribution.md @@ -1,48 +1,38 @@ +--- +title: Contribution +description: Find out how to help translate or build the app and extensions. +--- + # Contribution Find out how to help translate or build the app and extensions. -### Code +## Code Skilled at code? Know how to improve something or you generally want to support the creation of the app? -#### Application +### Application -The main application. +* The main application. +* Current active repository +* Planned rewrite repository -Current active repository +### Extensions +* Used to read from different manga services. +* Current active repository +* Planned rewrite repository - -Planned rewrite repository - - -#### Extensions - -Used to read from different manga services. - - -Current active repository - - - -Planned rewrite repository - - -#### Website +### Website The repository that hosts this very website you're reading on now. +* Current active repository -Current active repository - - -### Translation - -![](https://hosted.weblate.org/widgets/tachiyomi/-/strings/open-graph.png) - +## Translation +![Graph of Weblate Translations](https://hosted.weblate.org/widgets/tachiyomi/-/strings/open-graph.png) Want to help translate the app to your language? You can easily help by utilizing a service we use called **Weblate**. @@ -53,8 +43,6 @@ Want to help translate the app to your language? You can easily help by utilizin * [Subscriptions](https://docs.weblate.org/en/latest/user/profile.html#subscriptions) * [Glossary](https://docs.weblate.org/en/latest/user/translating.html#glossary) -### Donation +## Donation If you can't contribute code or translations but you still wish to help, then you can choose to contribute directly to the projects founder, [Inorichi](https://github.com/inorichi/) using Ko-fi. - - diff --git a/src/docs/faq/application/android-11+.md b/src/docs/faq/application/android-11+.md index ff056e17..fa0753e2 100644 --- a/src/docs/faq/application/android-11+.md +++ b/src/docs/faq/application/android-11+.md @@ -1,14 +1,21 @@ -# Android 11 and above +--- +title: Android 11+ +description: WIP +--- -### What changed in Android 11? +# Android 11+ -In Android 11, Google began forcing users to use [Scoped Storage](https://developer.android.com/about/versions/11/privacy/storage), which was introduced in Android 5.0 Lollipop, but Google only began forcing developers to use it on Android 11. Some OEMs seem to better implement Scoped Storage than others, with some users not running into any issues while users using other phone brands have multitudes of problems. +## What changed in Android 11? -### What does it mean for Tachiyomi? +In Android 11, Google began forcing users to use [Scoped Storage](https://developer.android.com/about/versions/11/privacy/storage), which was introduced in Android 5.0 Lollipop, but Google only began forcing developers to use it on Android 11. +Some OEMs seem to better implement Scoped Storage than others, with some users not running into any issues while users using other phone brands have multitudes of problems. -The introduction of Scoped Storage means that many storage-related functions that Tachiyomi uses may be much slower due to the inherent slowness of Scoped Storage, as outlined [here](https://www.xda-developers.com/android-q-storage-access-framework-scoped-storage/). These include deleting chapters, library load times, accessing the folders outside the data folders to download to or read from, and more. +## What does it mean for Tachiyomi? -### Is there any way to improve performance? +The introduction of Scoped Storage means that many storage-related functions that Tachiyomi uses may be much slower due to the inherent slowness of Scoped Storage, as outlined [here](https://www.xda-developers.com/android-q-storage-access-framework-scoped-storage/). +These include deleting chapters, library load times, accessing the folders outside the data folders to download to or read from, and more. + +## Is there any way to improve performance? You can try the command below if you know how to use ADB, a guide on installing it is also outlined on the site here. diff --git a/src/docs/faq/application/browse/index.md b/src/docs/faq/application/browse/index.md index fb04a17b..6a47bf40 100644 --- a/src/docs/faq/application/browse/index.md +++ b/src/docs/faq/application/browse/index.md @@ -1,31 +1,39 @@ +--- +title: Browse +description: WIP +--- + # Browse -### **Why can I not see sources that I have installed?** +## Why can I not see sources that I have installed? -**If it is an extension that is not the same language as your phone's primary language** +#### If it is an extension that is not the same language as your phone's primary language Enable the language of the source by going to Browse → Sources tab → Filter → Turn on the language of the source you would like to use. -**If it is an NSFW extension** +#### If it is an NSFW extension Settings → Browse → Check show in sources list. -### **How do I find a manga I am looking for?** +### How do I find a manga I am looking for? -Sometimes you can struggle to find a source that has the manga you are looking to read. Here are some tips to help you find it: +Sometimes you can struggle to find a source that has the manga you are looking to read. +Here are some tips to help you find it: Tips to find your manga 1. Look up the manga on [Google](https://google.com/) or a manga database such as [MangaUpdates](https://www.mangaupdates.com/). -2. See if the manga has any alternate spellings or other title variations. Try searching again in your sources with the alternate titles you found. -3. If you still cannot find the manga in any of your sources, then try to search for an extension for the website you found in step 1 in the extensions list. +1. See if the manga has any alternate spellings or other title variations. + 1. Try searching again in your sources with the alternate titles you found. +1. If you still cannot find the manga in any of your sources, then try to search for an extension for the website you found in step 1 in the extensions list. -**If you find the manga on a specific scanlator or aggregator and they do have an extension** +#### If you find the manga on a specific scanlator or aggregator and they do have an extension Download the corresponding extension, tap on it under → **Sources**, and then search for the manga there. -**If you find the manga on a specific scanlator or aggregator and they do not have an extension** +#### If you find the manga on a specific scanlator or aggregator and they do not have an extension -Check if adding the site as an extension has [already been requested](https://github.com/tachiyomiorg/tachiyomi-extensions/issues) and that it is not on the list of extensions that will not be added back [here](https://github.com/tachiyomiorg/tachiyomi-extensions/issues/3475). If it has not been requested and it is not on the list, you can [request it here](https://github.com/tachiyomiorg/tachiyomi-extensions/issues/new/choose). +Check if adding the site as an extension has [already been requested](https://github.com/tachiyomiorg/tachiyomi-extensions/issues) and that it is not on the list of extensions that will not be added back [here](https://github.com/tachiyomiorg/tachiyomi-extensions/issues/3475). +If it has not been requested and it is not on the list, you can [request it here](https://github.com/tachiyomiorg/tachiyomi-extensions/issues/new/choose). If the scanlator or aggregator does not have an online manga reader, you can download the manga from their website and set up the series as a local manga. diff --git a/src/docs/faq/application/browse/reading-with-local-source.md b/src/docs/faq/application/browse/reading-with-local-source.md index 39dc78b0..44a7b102 100644 --- a/src/docs/faq/application/browse/reading-with-local-source.md +++ b/src/docs/faq/application/browse/reading-with-local-source.md @@ -1,20 +1,31 @@ +--- +title: Reading with Local Source +description: WIP +--- + # Reading with Local Source -### **How do I import my downloaded manga into Tachiyomi?** +## How do I import my downloaded manga into Tachiyomi?* We recommend you to read [this](../../../guides/local-manga.md) guide on how to do so. -### **What do I do if I cannot find the Tachiyomi folder?** +## What do I do if I cannot find the Tachiyomi folder? If you do not see the **Tachiyomi** folder, create one with a file manager. -### **How do I fix empty/blank covers on my local manga?** +## How do I fix empty/blank covers on my local manga? -Sometimes some covers for local manga are not displayed. Follow these steps to fix it: +Sometimes some covers for local manga are not displayed. +Follow these steps to fix it: -1. Make sure you have created the right folder structure. To check that you have, open the manga with the missing cover and check if you can read chapters in the app. If not, follow this guide first. -2. Take a screenshot of which chapters you have read, and then remove manga from the library. -3. Go to → → and tap **Clear database**. This will only affect manga that are not in your library. -4. Go back to the → **Local source** and find the manga. The cover should be fixed now. Add the manga back to your library, mark your read chapters, and re-add tracking if needed. ::: +1. Make sure you have created the right folder structure. + 1. To check that you have, open the manga with the missing cover and check if you can read chapters in the app. + 1. If not, follow this guide first. +1. Take a screenshot of which chapters you have read, and then remove manga from the library. +1. Go to → → and tap **Clear database**. + 1. This will only affect manga that are not in your library. +1. Go back to the → **Local source** and find the manga. + 1. The cover should be fixed now. + 1. Add the manga back to your library, mark your read chapters, and re-add tracking if needed. Related GitHub issue: [#932](https://github.com/tachiyomiorg/tachiyomi/issues/932) diff --git a/src/docs/faq/application/downloads.md b/src/docs/faq/application/downloads.md index 62922b17..9f01341b 100644 --- a/src/docs/faq/application/downloads.md +++ b/src/docs/faq/application/downloads.md @@ -1,37 +1,48 @@ +--- +title: Downloads +description: WIP +--- + # Downloads -## Downloads +## How do I download several chapters or manga simultaneously? -### **How do I download several chapters or manga simultaneously?** - -The app does not allow parallel downloads from one source to prevent IP bans caused by too many requests. We know that speed is being sacrificed, but it is better than an overall inaccessible source. +The app does not allow parallel downloads from one source to prevent IP bans caused by too many requests. +We know that speed is being sacrificed, but it is better than an overall inaccessible source. However, if you download several manga from different sources, the app will start downloading simultaneously from up to five different sources. -### **Why do my downloads sometimes stop midway through?** +## Why do my downloads sometimes stop midway through? -It is likely an issue to do with your connection to your network or the source. Tachiyomi will notify you of what error it has encountered trying to download. +It is likely an issue to do with your connection to your network or the source. +Tachiyomi will notify you of what error it has encountered trying to download. -**Why aren't my downloads being detected?** +### Why aren't my downloads being detected? This can happen for a variety of reasons: -* The download location may be inaccessible. If you are using an SD card, make sure it's detected. -* The source name may have changed. Change the name of the source's folder to the new name. -* The source you downloaded the manga from may have changed the title. Change the title of the folder to the new title. +* The download location may be inaccessible. + * If you are using an SD card, make sure it's detected. +* The source name may have changed. + * Change the name of the source's folder to the new name. +* The source you downloaded the manga from may have changed the title. + * Change the title of the folder to the new title. -### **How do I cancel or change the download queue?** +## How do I cancel or change the download queue? -Go to **More** → **Download Queue** and cancel items in the queue or cancel all items by tapping on the overflow next to a manga chapter or on the top right. If you would like the change the order of the queue, tap and hold the = on the side of an item in the queue. +Go to **More** → **Download Queue** and cancel items in the queue or cancel all items by tapping on the overflow next to a manga chapter or on the top right. +If you would like the change the order of the queue, tap and hold the = on the side of an item in the queue. -### **Can you make it possible to store manga on both internal storage and external SD-card?** +## Can you make it possible to store manga on both internal storage and external SD-card? -At the moment, no. You could try using symlinks, but that requires having your device rooted. +At the moment, no. +You could try using symlinks, but that requires having your device rooted. Read more about rooting your device [here](https://www.xda-developers.com/root/) -### **Why can I see manga pages from my downloads in my device's photo gallery?** +## Why can I see manga pages from my downloads in my device's photo gallery? -Tachiyomi adds a `.nomedia` file to the Downloads folder by default to prevent this from happening, but sometimes it does not work, or something goes wrong. To fix this, all you need to do is create the file yourself. Name it `.nomedia` and place it in your downloads folder. If you have the same problem with your local manga, place the `.nomedia` file in the local folder. - -## +Tachiyomi adds a `.nomedia` file to the Downloads folder by default to prevent this from happening, but sometimes it does not work, or something goes wrong. +To fix this, all you need to do is create the file yourself. +Name it `.nomedia` and place it in your downloads folder. +If you have the same problem with your local manga, place the `.nomedia` file in the local folder. diff --git a/src/docs/faq/application/index.md b/src/docs/faq/application/index.md index 657c7688..870994a7 100644 --- a/src/docs/faq/application/index.md +++ b/src/docs/faq/application/index.md @@ -1,33 +1,36 @@ --- +title: Application - FAQ description: Frequently Asked Questions related to the Application. --- # Application -## **What is Tachiyomi Preview?** +## What is Tachiyomi Preview? -It is a weekly updated, beta version of the app. It contains features that may be added to Tachiyomi in the future and is more prone to bugs and crashes. It is intended for users who would like the bleeding edge of Tachiyomi as soon as it comes out. +It is a weekly updated, beta version of the app. +It contains features that may be added to Tachiyomi in the future and is more prone to bugs and crashes. +It is intended for users who would like the bleeding edge of Tachiyomi as soon as it comes out. If you are willing to use Tachiyomi Preview, be sure to turn on auto-backup to prevent losing your library due to potential bugs or crashes. ## Updating the application -### **How do I enable automatic updates?** +### How do I enable automatic updates? -From version **0.9.0** and onwards, Tachiyomi has had automatic updates for the app enabled by default. The **Preview** version also has automatic updates enabled by default. +From version **0.9.0** and onwards, Tachiyomi has had automatic updates for the app enabled by default. +The **Preview** version also has automatic updates enabled by default. However, if you think you are on an outdated version, go to **More** → **About** and tap on **Check for updates**. -### **Why are automatic updates not working?** +### Why are automatic updates not working? -Certain Android skins like MIUI have very aggressive battery saving, which can kill the app in the background. To whitelist Tachiyomi from your battery saver, go to **More** → **Settings** → **Advanced** and tap on **Disable battery optimization**. If that does not work, you can also visit [DontKillMyApp](https://dontkillmyapp.com/) to see what battery saving options your device has and how to disable or circumvent them. +Certain Android skins like MIUI have very aggressive battery saving, which can kill the app in the background. +To whitelist Tachiyomi from your battery saver, go to **More** → **Settings** → **Advanced** and tap on **Disable battery optimization**. +If that does not work, you can also visit [DontKillMyApp](https://dontkillmyapp.com/) to see what battery saving options your device has and how to disable or circumvent them. ## Uninstalling the application -### **Why am I unable to uninstall Tachiyomi?** +### Why am I unable to uninstall Tachiyomi? -On **Android 10**, a bug was introduced that prevented users from uninstalling the app if the device had a MicroSD card. To fix the issue, please remove the MicroSD card from the device first, then uninstall Tachiyomi. - -## - -## +On **Android 10**, a bug was introduced that prevented users from uninstalling the app if the device had a MicroSD card. +To fix the issue, please remove the MicroSD card from the device first, then uninstall Tachiyomi. diff --git a/src/docs/faq/application/library.md b/src/docs/faq/application/library.md index 5e0aa191..aef5f140 100644 --- a/src/docs/faq/application/library.md +++ b/src/docs/faq/application/library.md @@ -1,10 +1,15 @@ +--- +title: Library +description: TBA +--- + # Library -### **How can I see how many chapters I have downloaded or unread?** +## How can I see how many chapters I have downloaded or unread? Enable badges by going to Library → Filter → **Display** tab and then checking **Download badges** or **Unread badges** at the bottom. -### **Why does global update skip some entries?** +## Why does global update skip some entries? By default, the app does not check for updates if an entry: @@ -12,15 +17,18 @@ By default, the app does not check for updates if an entry: * Hasn't been started * Has "Completed" status -This helps avoid unnecessary heavy traffic to sources to help ensure that they stay available. If you have entries that get infrequent or no updates, you should consider using categories and excluding them from updates. +This helps avoid unnecessary heavy traffic to sources to help ensure that they stay available. +If you have entries that get infrequent or no updates, you should consider using categories and excluding them from updates. We recommend to **keep the defaults as they are** and read your unread chapters first. If you don't want to see the skipped items notification, you can disable it at More → Settings → General → **Manage notifications** (Android 8+). -### **Why does the app warn about large bulk updates and downloads?** +## Why does the app warn about large bulk updates and downloads? -Excessive server queries and unnecessary site interaction may cause sources to employ anti-Tachiyomi tactics. Also refer to the above question. Long running update checks and downloading may also negatively impact your battery life. +Excessive server queries and unnecessary site interaction may cause sources to employ anti-Tachiyomi tactics. +Also refer to the above question. +Long running update checks and downloading may also negatively impact your battery life. Tips to reduce server load As mentioned above, it is **recommended to keep the defaults as they are**, but if you are still seeing this warning message, try the following suggestions: @@ -28,19 +36,24 @@ Tips to reduce server load As mentioned above, it is **recommended to keep the d * Update only the Reading category by going to More → Settings → Library → **Global update** then tap **Categories**. * If the warning message still occurs, split your reading category down further by seperating entries in your library that are infrequently updated (such as monthly series or series that are on haitus) into a new category, then set global update to only update your more frequently updated reading category -### **How do I ignore duplicate chapters?** +## How do I ignore duplicate chapters? -Sometimes, you find a manga that is translated by more than one group. Because of this, you get multiple releases for each chapter in the manga. There are several ways to skip the duplicate chapters: +Sometimes, you find a manga that is translated by more than one group. +Because of this, you get multiple releases for each chapter in the manga. +There are several ways to skip the duplicate chapters: -* Bookmark or mark as read the unwanted chapters, then tap on → **Filter** and double-tap **Bookmarked** or single-tap **Unread**, respectively. This will hide any bookmarked or read chapters and skip them as you read along, as long as you have **Skip filtered chapters** enabled under More → Settings → Reader → **Reading**. -* Migrate to another source that does not have duplicates. For more information on how to migrate a manga, see the migration guide. +* Bookmark or mark as read the unwanted chapters, then tap on → **Filter** and double-tap **Bookmarked** or single-tap **Unread**, respectively. +* This will hide any bookmarked or read chapters and skip them as you read along, as long as you have **Skip filtered chapters** enabled under More → Settings → Reader → **Reading**. +* Migrate to another source that does not have duplicates. +* For more information on how to migrate a manga, see the migration guide. -### **Why are some cover thumbnails corrupted, white, showing a broken page, or wrong?** +## Why are some cover thumbnails corrupted, white, showing a broken page, or wrong? -The thumbnail download likely did not complete correctly. To fix this, refresh the covers in settings. +The thumbnail download likely did not complete correctly. +To fix this, refresh the covers in settings. Refresh your covers by going to More → Settings → Advanced then pressing **Refresh library manga covers**. -### **Why have some manga chapters been marked as unread when I have not touched them?** +## Why have some manga chapters been marked as unread when I have not touched them? The URLs of the manga chapters have changed, so Tachiyomi detects the chapter(s) as new chapters. diff --git a/src/docs/faq/application/reader.md b/src/docs/faq/application/reader.md index c7400a13..0312166f 100644 --- a/src/docs/faq/application/reader.md +++ b/src/docs/faq/application/reader.md @@ -1,13 +1,23 @@ +--- +title: Reader +description: TBA +--- + # Reader -### **Why are some images not displayed?** +## Why are some images not displayed? Aside from network issues, sometimes Tachiyomi does not register the image as existing, exit, and re-enter the reader to fix this. -### **Will there ever be a dual-page reader option?** +## Will there ever be a dual-page reader option? The logic required to make a dual-page reader automatically work along with scanlator page inconsistencies and other issues means it is unlikely to be added at this time. -**How can I make Tachiyomi turn pages with the volume rocker? Can I reverse the tapping direction? Can I change the tapping zones?** +
-Refer to the guides section of the site here. Refer to here if you want to use your volume rocker to navigate pages. +### How can I make Tachiyomi turn pages with the volume rocker? +### Can I reverse the tapping direction? +### Can I change the tapping zones? + +Refer to the guides section of the site here. +Refer to here if you want to use your volume rocker to navigate pages. diff --git a/src/docs/faq/application/shizuku.md b/src/docs/faq/application/shizuku.md index 30d8a9e9..8293f7d3 100644 --- a/src/docs/faq/application/shizuku.md +++ b/src/docs/faq/application/shizuku.md @@ -1,19 +1,30 @@ +--- +title: Shizuku +description: TBA +--- + # Shizuku -#### What is Shizuku? +## What is Shizuku? -Tachiyomi can use Shizuku as an alternate way to install and update extensions. It accesses system APIs to install packages directly without user input. Shizuku requires setup with ADB or root privileges. Read more about it [here](https://shizuku.rikka.app/introduction/). +Tachiyomi can use Shizuku as an alternate way to install and update extensions. +It accesses system APIs to install packages directly without user input. +Shizuku requires setup with ADB or root privileges. +Read more about it [here](https://shizuku.rikka.app/introduction/). -#### Do I need Shizuku? +## Do I need Shizuku? No, only use Shizuku if you want to avoid being prompted during extension installations. -#### How do I set Shizuku up? +## How do I set Shizuku up? -To learn how to set Shizuku up, go [here](https://shizuku.rikka.app/guide/setup/). Once you have set it up, enable it in Tachiyomi by going to **More** → **Settings** → **Advanced** → **Installer**. +To learn how to set Shizuku up, go [here](https://shizuku.rikka.app/guide/setup/). +Once you have set it up, enable it in Tachiyomi by going to **More** → **Settings** → **Advanced** → **Installer**. -#### What is the difference between the installers? +## What is the difference between the installers? -* **Legacy**: fallback method installer if the standard PackageInstaller has issues. This is the default for MIUI. -* **PackageInstaller**: The default installer. This has more features depending on the Android version, such as skipping user prompts on Android 12 when updating extensions. +* **Legacy**: fallback method installer if the standard PackageInstaller has issues. + * This is the default for MIUI. +* **PackageInstaller**: The default installer. + * This has more features depending on the Android version, such as skipping user prompts on Android 12 when updating extensions. * **Shizuku**: See above. diff --git a/src/docs/faq/application/user-interface.md b/src/docs/faq/application/user-interface.md index 1365fae7..80d90757 100644 --- a/src/docs/faq/application/user-interface.md +++ b/src/docs/faq/application/user-interface.md @@ -1,5 +1,13 @@ -# User Interface +--- +title: User interface +description: TBA +--- -### **Can I change the app language?** +# User interface -No. It was removed due to it causing small bugs everywhere in **Tachiyomi**. Android does not provide a standard way of selecting a language that's not your device-language. You can improve the quality of the translations in your language [here](https://hosted.weblate.org/projects/tachiyomi/) or change your system language. +## Can I change the app language? + +No. +It was removed due to it causing small bugs everywhere in **Tachiyomi**. +Android does not provide a standard way of selecting a language that's not your device-language. +You can improve the quality of the translations in your language [here](https://hosted.weblate.org/projects/tachiyomi/) or change your system language. diff --git a/src/docs/faq/extensions.md b/src/docs/faq/extensions.md index 0e07f2d0..a81d12d9 100644 --- a/src/docs/faq/extensions.md +++ b/src/docs/faq/extensions.md @@ -1,60 +1,65 @@ --- +title: Extensions - FAQ description: Frequently Asked Questions related to Extensions. --- # Extensions +Frequently Asked Questions related to Extensions. + ## General -### **What are some recommended extensions? What source is the best? What is the replacement for source X? Where to read manga Y?** +### What are some recommended extensions? What source is the best? What is the replacement for source X? Where to read manga Y? -Tachiyomi does not endorse or recommend any manga source, and there is no best extension. Instead, we encourage users to spend some time trying out a few sources themselves and discover what sources work best for them. What works well for somebody else might not work well for you. +Tachiyomi does not endorse or recommend any manga source, and there is no best extension. +Instead, we encourage users to spend some time trying out a few sources themselves and discover what sources work best for them. +What works well for somebody else might not work well for you. Tachiyomi is not hosting any content, we are not affiliated with or responsible for any source that is; slow, down, missing chapters, or has subpar image quality. +
-### **What are scanlator sources?** +### What are scanlator sources? -Manga that are not officially licensed are translated by scanlators, who either publish on their websites or **MangaDex**. This practice contrasts with official sources like **MANGA Plus By SHUEISHA** or **VIZ Shonen Jump**, which host officially licensed and translated manga. +Manga that are not officially licensed are translated by scanlators, who either publish on their websites or **MangaDex**. +This practice contrasts with official sources like **MANGA Plus By SHUEISHA** or **VIZ Shonen Jump**, which host officially licensed and translated manga. Learn more about scanlation in this **Wikipedia** [**article**](https://en.wikipedia.org/wiki/Scanlation). -**How do I request a new extension?** +#### How do I request a new extension? -Open an issue on [GitHub](https://github.com/tachiyomiorg/tachiyomi-extensions/issues) if one does not already exist. Make sure it is not on the removed extensions list [here](https://github.com/tachiyomiorg/tachiyomi-extensions/issues/3475) first. +Open an issue on [GitHub](https://github.com/tachiyomiorg/tachiyomi-extensions/issues) if one does not already exist. +Make sure it is not on the removed extensions list [here](https://github.com/tachiyomiorg/tachiyomi-extensions/issues/3475) first. You can find the list of extensions to download [here](https://tachiyomi.org/extensions/) -### **How do I allow third-party installations?** - +
+### How do I allow third-party installations? When installing your first extension and you are prompted that your device _is not allowed_ to install unknown apps from that source, follow the prompt to allow it. In _newer_ versions of **Android**, you need to enable **Install unknown apps** on a per-app basis. - - When installing your first extension and you are prompted that your device _is not allowed_ to install unknown apps from that source, follow the prompt to allow it. In _older_ versions of **Android**, you only need to enable **Unknown sources** globally. - - If you need more help regarding this, read [this](https://www.theandroidsoul.com/how-to-allow-apps-installation-from-unknown-sources-on-android-9-pie/) -### **How do I uninstall an extension?** +
-Extensions for **Tachiyomi** are technically installed the same as standard apps. Either you uninstall them through the app section on your device's settings or do it in **Tachiyomi**. +### How do I uninstall an extension? +Extensions for **Tachiyomi** are technically installed the same as standard apps. +Either you uninstall them through the app section on your device's settings or do it in **Tachiyomi**. To uninstall an extension from within **Tachiyomi**, go to → **Extensions** then tap **Uninstall** on the extension you want to remove. - ## Removed Extensions -### **Why am I unable to download an extension that used to exist?** +### Why am I unable to download an extension that used to exist? Extensions tend to be removed for a variety of reasons: @@ -69,24 +74,39 @@ A list of extensions that have been removed is available [here](https://github.c ## Split Extensions -Extensions have been split due to the sheer number of extensions in a single extension, with Madara reaching over 200 extensions at one point, making it unreasonable for both devs and users to filter through extensions. For a deeper explanation of the issue, [this](https://github.com/tachiyomiorg/tachiyomi-extensions/issues/4287) GitHub issue explains in more detail. +Extensions have been split due to the sheer number of extensions in a single extension, with Madara reaching over 200 extensions at one point, making it unreasonable for both devs and users to filter through extensions. +For a deeper explanation of the issue, [this](https://github.com/tachiyomiorg/tachiyomi-extensions/issues/4287) GitHub issue explains in more detail. -### **What extensions have been split?** +
+ +### What extensions have been split? All of them have been split. -### **Why does my multisource extension show up as obsolete?** +
-The multisource extension is obsolete because it has been split. The multisource extension has been removed from the repository. It is not actually obsolete. +### Why does my multisource extension show up as obsolete? -### **How do I move to a split extension?** +The multisource extension is obsolete because it has been split. +The multisource extension has been removed from the repository. +It is not actually obsolete. -Install the extension that your manga is from, and then uninstall the multisource extension. If the manga shows the source as a bunch of numbers, force close the app. For known issues with split extensions, go to this [GitHub issue](https://github.com/tachiyomiorg/tachiyomi-extensions/issues/5672). +
-### **Do I need to migrate?** +### How do I move to a split extension? + +Install the extension that your manga is from, and then uninstall the multisource extension. +If the manga shows the source as a bunch of numbers, force close the app. +For known issues with split extensions, go to this [GitHub issue](https://github.com/tachiyomiorg/tachiyomi-extensions/issues/5672). + +
+ +### Do I need to migrate? No, unless expressly stated, the internal ID of sources has not changed, so migration is unnecessary. -### **What if I uninstall the multisource extension before I install the singular extensions?** +
+ +### What if I uninstall the multisource extension before I install the singular extensions? See what extension IDs correspond to what extensions [here](https://pastebin.com/raw/QX2scdRT). diff --git a/src/docs/faq/general.md b/src/docs/faq/general.md index fd4db9d0..ed2caeca 100644 --- a/src/docs/faq/general.md +++ b/src/docs/faq/general.md @@ -1,4 +1,5 @@ --- +title: General - FAQ description: Frequently Asked Questions --- @@ -6,28 +7,36 @@ description: Frequently Asked Questions Frequently Asked Questions ## Will there be an iOS version? -No. There is no iOS version, and there are no plans for one. Since iOS and Android apps do not share code, it is hard to port. +No. +There is no iOS version, and there are no plans for one. +Since iOS and Android apps do not share code, it is hard to port. ## Will Tachiyomi ever be on the Google Play Store? -Google Play's content policy does not allow the APK based extension system to work. The content on some websites will lead to Google taking it down at some point, and Inorichi does not want to have to deal with it as they have stated before. +Google Play's content policy does not allow the APK based extension system to work. +The content on some websites will lead to Google taking it down at some point, and Inorichi does not want to have to deal with it as they have stated before. To report Tachiyomi copycats on the Google Play Store, you can fill out this form following these steps. ## How do I migrate from the F-Droid version? -Tachiyomi on F-Droid is not officially supported, so updates are not guaranteed. If you want to migrate to the official builds: +Tachiyomi on F-Droid is not officially supported, so updates are not guaranteed. +If you want to migrate to the official builds: 1. Create a backup. 1. Uninstall the F-Droid version (do not keep any app data if it allows you to). 1. Download and install Tachiyomi. 1. Restore your backup. -We have no intention to host our own F-Droid repo since Tachiyomi already manages updates by itself, making the usage of F-Droid redundant. For more detailed info, see this GitHub comment. +We have no intention to host our own F-Droid repo since Tachiyomi already manages updates by itself, making the usage of F-Droid redundant. +For more detailed info, see this GitHub comment. ## Can Tachiyomi read light novels? -No. Tachiyomi is an image parser, not a text parser. +No. +Tachiyomi is an image parser, not a text parser. ## Can Tachiyomi stream anime? -No. Any project that calls itself Tachiyomi that supports anime is not affiliated with the main project. +No. +Any project that calls itself Tachiyomi that supports anime is not affiliated with the main project. ## Can Tachiyomi sync between devices? -No. But you can use Tachiyomi backup and restore features to save and load manga database and move manga content to another device. \ No newline at end of file +No. +But you can use Tachiyomi backup and restore features to save and load manga database and move manga content to another device. diff --git a/src/docs/faq/miscellaneous.md b/src/docs/faq/miscellaneous.md index ce517fec..fb009e33 100644 --- a/src/docs/faq/miscellaneous.md +++ b/src/docs/faq/miscellaneous.md @@ -1,35 +1,40 @@ --- +title: Miscellaneous - FAQ description: Frequently Asked Questions that does not fit the other categories. --- # Miscellaneous -### **What is a fork?** +## What is a fork? -Forks are alternative versions of Tachiyomi with different features. Read more about them here. +Forks are alternative versions of Tachiyomi with different features. +Read more about them here. -### **Can I revert from the Material Design 2 update of Tachiyomi?** +## Can I revert from the Material Design 2 update of Tachiyomi? While there will never be a toggle between the two UI versions, you can continue to use the old UI version by using TachiyomiAZ. -### **How do I pause reading history or go incognito?** +## How do I pause reading history or go incognito? Enable Incognito Mode by going to **More** → **Incognito Mode**. -### **Can I make Tachiyomi only read my downloaded chapters? Why am I not able to disable downloaded only?** +## Can I make Tachiyomi only read my downloaded chapters? Why am I not able to disable downloaded only? Enable Download only by going to **More** → **Download only**. -### **What is DNS over HTTPS?** +## What is DNS over HTTPS? -DNS over HTTPS is an experimental way of providing, as the name implies, DNS resolution via HTTPS. It provides the advantage of not being vulnerable to Man-in-the-middle attacks (due to TLS encryption in HTTPS), preventing DNS spoofing. If you would like to learn more, go [here](https://www.cloudflare.com/learning/dns/dns-over-tls/). It allows some blocks to be circumvented without using a VPN. +DNS over HTTPS is an experimental way of providing, as the name implies, DNS resolution via HTTPS. +It provides the advantage of not being vulnerable to Man-in-the-middle attacks (due to TLS encryption in HTTPS), preventing DNS spoofing. +If you would like to learn more, go [here](https://www.cloudflare.com/learning/dns/dns-over-tls/). +It allows some blocks to be circumvented without using a VPN. You can enable this feature by going to **More** → **Settings** → **Advanced**. -### **What should I do if I cannot screenshot within Tachiyomi?** +## What should I do if I cannot screenshot within Tachiyomi? You have Secure Screen on, disable it if you want to screenshot by going to **More** → **Settings** → **Security** → **Secure Screen**. -**How do I backup my library automatically? How do I move data from one phone to another?** +## How do I backup my library automatically? How do I move data from one phone to another? Learn how to use the backup and restore feature here, and learn how to enable automatic backups here diff --git a/src/docs/guides/backups.md b/src/docs/guides/backups.md index c7d7e653..ba0e75d2 100644 --- a/src/docs/guides/backups.md +++ b/src/docs/guides/backups.md @@ -1,66 +1,60 @@ --- -description: >- - Backups are inter-compatible between Tachiyomi versions, with a few exceptions - listed under forks information. +title: Backups +description: Backups are inter-compatible between Tachiyomi versions, with a few exceptions listed under forks information. --- # Backups -### What's in a backup? +Backups are inter-compatible between Tachiyomi versions, with a few exceptions listed under forks information. + +## What's in a backup? Backups can hold the following information: -1. **Titles** -2. **Categories** -3. **Read chapters** -4. **Tracking settings** -5. **Reading history** -6. **Manga information** such as Author, Artist, Date Added to Library, Selected Viewer, etc. +- **Titles** +- **Categories** +- **Read chapters** +- **Tracking settings** +- **Reading history** +- **Manga information** + - Author, Artist, Date Added to Library, Selected Viewer, Read Duration, etc. +You can do this by going to **More → Backup and Restore** and then selecting **Create backup** and select a location to save it. -You can do this by going to More → Backup and Restore and then selecting **Create backup** and select a location to save it. - - -### How do I restore a backup? +## How do I restore a backup? Restoring is done from the Backup and Restore settings. To restore a backup without issues be sure to: -* Log into the Tracking services that you previously used. +* Log into the Tracking services that you previously used. -### How can I make my new install of Tachiyomi detect my old downloads? +## How can I make my new install of Tachiyomi detect my old downloads? You can transfer downloaded manga chapters from one version of **Tachiyomi** to another. -### How do I make Tachiyomi automatically backup? +## How do I make Tachiyomi automatically backup? It is highly recommended you turn on auto backups, this will ensure you can recover if need be. +You can do this by going to **More → Settings → Backup** and then setting a **backup frequency**. +In the case of a catastrophic failure, at least you will be able to recover. -You can do this by going to **More → Settings → Backup** and then setting a **backup frequency**. In the case of a catastrophic failure, at least you will be able to recover. - - -### Forks information - - - -This fork can only restore **MangaDex** entries in a backup. If there are entries from other sources that are a part of that backup then they will not transfer. - +## Forks information +This fork can only restore **MangaDex** entries in a backup. +If there are entries from other sources that are a part of that backup then they will not transfer. This fork have some built-in extensions, namely: **E-Hentai**, **Hitomi.la**, and **nHentai** for TachiyomiAZ while TachiyomiSY only has **E-Hentai**. -Titles from said extensions will not be restored when restoring a backup made by these forks to standard Tachiyomi. It is possible to restore titles to these forks, but it is not possible to back them up out of these forks. +Titles from said extensions will not be restored when restoring a backup made by these forks to standard Tachiyomi. +It is possible to restore titles to these forks, but it is not possible to back them up out of these forks. This fork can only restore legacy backups, as it has not made the changes needed to support the new backup yet. - - This fork have some built-in extensions, namely: **E-Hentai**, **Hitomi.la**, and **nHentai** for TachiyomiAZ while TachiyomiSY only has **E-Hentai**. -Titles from said extensions will not be restored when restoring a backup made by these forks to standard Tachiyomi. It is possible to restore titles to these forks, but it is not possible to back them up out of these forks. +Titles from said extensions will not be restored when restoring a backup made by these forks to standard Tachiyomi. +It is possible to restore titles to these forks, but it is not possible to back them up out of these forks. This fork can only restore legacy backups, as it has not made the changes needed to support the new backup yet. - - diff --git a/src/docs/guides/categories.md b/src/docs/guides/categories.md index 43d67253..7d242bf9 100644 --- a/src/docs/guides/categories.md +++ b/src/docs/guides/categories.md @@ -1,7 +1,6 @@ --- -description: >- - Categories help you store your bookmarked manga in custom tabs, which keeps - your library neat and organized. +title: Categories +description: Categories help you store your bookmarked manga in custom tabs, which keeps your library neat and organized. --- # Categories @@ -10,55 +9,56 @@ description: >- You can even add your bookmarked manga in multiple categories and can easily control the update options through Library settings and automatically download new manga chapters from certain categories (if **Download new chapters** option is enabled in **Downloads** settings). -### Create a category +## Create a category To create a category, follow the steps below. 1. Go to More → Categories. -2. Press the **+ Add** button in the bottom right. -3. Enter a name and press **OK**. +1. Press the **+ Add** button in the bottom right. +1. Enter a name and press **OK**. -### Edit a category +## Edit a category To edit a category follow the steps below. 1. Go to More → Categories. -2. Long press a category. -3. Tap EDIT on the top-right. +1. Long press a category. +1. Tap EDIT on the top-right. -### Change category order +## Change category order -You can change the order of Categories, such as bringing a certain Category to the top. This category will appear as the first tab on Library. +You can change the order of Categories, such as bringing a certain Category to the top. +This category will appear as the first tab on Library. To do this, follow the steps below. 1. Go to More → Categories. -2. Drag the category to your preferred position using the Reorder icon. +1. Drag the category to your preferred position using the Reorder icon. -### Delete a category +## Delete a category To delete a category, follow the steps below. 1. Go to More → Categories. -2. Long press a category. -3. Tap DELETE on the top-right. +1. Long press a category. +1. Tap DELETE on the top-right. -### Add manga to the category +## Add manga to the category To add manga to a category, follow the steps below. 1. Long press the manga you want to add. -2. Press the Set categories button. -3. Select which category or categories you want it in and press **OK**. +1. Press the Set categories button. +1. Select which category or categories you want it in and press **OK**. > You can also add multiple manga to a category by selecting them when you see the Set categories button. -### Remove manga from the category +## Remove manga from the category To remove manga from a category, follow the steps below. 1. Long press the manga that you want to remove. -2. Press the Set categories button. -3. Deselect the category or categories you want to remove it from and press **OK**. +1. Press the Set categories button. +1. Deselect the category or categories you want to remove it from and press **OK**. > You can also remove multiple manga from a category by selecting them when you see the Set categories button. diff --git a/src/docs/guides/getting-started.md b/src/docs/guides/getting-started.md index 03383b32..facdfea1 100644 --- a/src/docs/guides/getting-started.md +++ b/src/docs/guides/getting-started.md @@ -1,10 +1,16 @@ +--- +title: Getting started +description: Essential information to help you get set up with Tachiyomi. +--- + # Getting started -### Installation +## Installation -You can download the latest version of **Tachiyomi** by going to our download page. When you've completed the download, open the APK file and proceed with installing it. +You can download the latest version of **Tachiyomi** by going to our download page. +When you've completed the download, open the APK file and proceed with installing it. -### Installing an extension +## Installing an extension Now that **Tachiyomi** is installed, open the app and navigate to Browse, and then switch to the **Extensions** tab. @@ -12,9 +18,10 @@ Find the extension that you'd like to use then press the INSTALL button next to You _might_ need to give **Tachiyomi** permission to _install unknown apps_, you can read how to do so here. -### Adding manga to your library +## Adding manga to your library -Now that you've installed the desired extension, it will show in the **Sources** tab. This page contains all of your sources, which is obtained through extensions, some extensions contain _multiple_ sources. +Now that you've installed the desired extension, it will show in the **Sources** tab. +This page contains all of your sources, which is obtained through extensions, some extensions contain _multiple_ sources. To find and add manga to your library, tap **Latest** for a source's most recently updated manga, or tap on the source itself to browse and search their catalog. diff --git a/src/docs/guides/img/TachiyomiAZ b/src/docs/guides/img/TachiyomiAZ deleted file mode 100644 index a7663f27..00000000 --- a/src/docs/guides/img/TachiyomiAZ +++ /dev/null @@ -1,59 +0,0 @@ - - - - TachiyomiAZ - Tachiyomi - - - - - -

TachiyomiAZ

Stable

v0.00.0

Preview

v0.00.0

GitHub

- Requires - Android 5.0 - or higher. -

The BEST fork --az4521

Introduction

TachiyomiAZ is maintained by az4521 and Syer10.

This hentai focused fork is based off of TachiyomiEH, it has most features and fixes from Tachiyomi, as well as features from TachiyomiJ2K. It has decided to keep the hamburger menu style of navigation, compared to the other forks that are moving to the new bottom navigation style.

Features

Special Sources (integrated plus added features)

  • E-Hentai/ExHentai
  • nHentai
  • Hitomi.la
  • 8Muses
  • HBrowse
  • Perv Eden

Delegated Sources (Sources with added features if installed)

  • Puruin
  • Tsumino
  • HentaiCafe (Foolside)

From EH:

  • Save Searches for use later
  • AutoScroll
  • Boost Page (force redownload page)
  • Page download thread customization
  • Predownload the whole chapter while reading (Optional)
  • Retry immidently instead of wating for the rest of the preloaded pages to finish downloading
  • Customize image cache size (how much space Tachiyomi has available to store future pages)
  • Sync your favorites with your EHentai/ExHentai account
  • Batch import E-Hentai/ExHentai URLs (import single URLs by pasting them into the source search box)
  • Automatic CAPTCHA solving

From EH and fixed/changed:

  • Auto Migration (Originally from EH, it was then improved in J2k, and we have reintegrated the J2k version)
  • Merged Sources (Merge 2 or more versions of a manga to get chapters from all of them)
  • App and notification lock with fingerprint and PIN unlock
  • Restoring backups in the background
  • Fixed Tsumino and Hitomi
  • Language filtering search options for nHentai
  • Tri-state filter when filtering in library
  • Random bugfixes

Original AZ Features:

  • Maintained hamburger navigation
  • Grid view corner rounding configuration
  • Manga recommendations
- - - diff --git a/src/docs/guides/img/TachiyomiEH b/src/docs/guides/img/TachiyomiEH deleted file mode 100644 index 40c09d2c..00000000 --- a/src/docs/guides/img/TachiyomiEH +++ /dev/null @@ -1,57 +0,0 @@ - - - - TachiyomiEH - Tachiyomi - - - - - -

TachiyomiEH

- Deprecated -

Introduction

TachiyomiEH is maintained by NerdNumber9.

This fork adds features that enhances the hentai experience with integrations to popular sevices such as E-Hentai, nHentai and more.

At the moment, it is deprecated as the developer does not have time to maintain it. Use TachiyomiAZ instead.

Features

  • Sync your favorites with your EHentai/ExHentai account
  • Search through your favorites by tag/language/artist
  • Open galleries in an incognito browser window
  • Faster download engine in the reader
  • Fingerprint/PIN app lock
  • Batch import gallery URLs
    • Import single URLs by pasting them into the catalogue search box
  • Automatic captcha solving
  • Open gallery URLs directly in Tachiyomi
- - - diff --git a/src/docs/guides/img/TachiyomiJ2K b/src/docs/guides/img/TachiyomiJ2K deleted file mode 100644 index 3f6c0706..00000000 --- a/src/docs/guides/img/TachiyomiJ2K +++ /dev/null @@ -1,59 +0,0 @@ - - - - TachiyomiJ2K - Tachiyomi - - - - - -

TachiyomiJ2K

Download

v0.00.0

GitHub

- Requires - Android 6.0 - or higher. -

Introduction

TachiyomiJ2K is maintained by Jays2Kings.

This fork takes a new approach to the design of the base app along with several other enhancements.

Features

  • New Manga details screen
  • New Recents page
    • Providing quick access to newly added manga, new chapters, and to continue where you left on in a series
  • Android 10 Edge to Edge support
    • No more small ugly bar for the gesture navigation.
    • Older versions get a translucent nav bar instead.
  • Automatic background based on manga page
    • For those that like having a white background to match the content, this will automatically set the background to match for moments such as a flashback section of a manga.
  • Reader seekbar overrides switch app gesture in Android 10, so no more accidents for that
  • New material snackbar
    • Removing manga now auto deletes chapters and has an undo button in case you change your mind.
  • Library specific enhancements
    • Library Categories are stacked vertically
    • Per-category/Drag & drop sorting
    • Tri-state/Negative filters
    • Multi-source migration
    • Sort by Date Added (Taken from Neko.)
  • Share sheets upgrade for Android 10
  • Batch Auto-Source Migration
  • Recently Read goes all the way back to the beginning of time
  • Restoring backups in the background
  • Expanding manga thumbnails
  • A lot more Material Design 2 additions
- - - diff --git a/src/docs/guides/img/image (1).png b/src/docs/guides/img/guides_nav-edge-light.png similarity index 100% rename from src/docs/guides/img/image (1).png rename to src/docs/guides/img/guides_nav-edge-light.png diff --git a/src/docs/guides/img/image (3).png b/src/docs/guides/img/guides_nav-kindlish-light.png similarity index 100% rename from src/docs/guides/img/image (3).png rename to src/docs/guides/img/guides_nav-kindlish-light.png diff --git a/src/docs/guides/img/image.png b/src/docs/guides/img/guides_nav-l-light.png similarity index 100% rename from src/docs/guides/img/image.png rename to src/docs/guides/img/guides_nav-l-light.png diff --git a/src/docs/guides/img/image (2).png b/src/docs/guides/img/guides_nav-right-and-left-light.png similarity index 100% rename from src/docs/guides/img/image (2).png rename to src/docs/guides/img/guides_nav-right-and-left-light.png diff --git a/src/docs/guides/local-manga.md b/src/docs/guides/local-manga.md index d86754fb..eb402736 100644 --- a/src/docs/guides/local-manga.md +++ b/src/docs/guides/local-manga.md @@ -1,30 +1,37 @@ --- -description: >- - If you like to download and organize your media, then you want to know how to - manage your own manga in Tachiyomi. +title: Local manga +description: If you like to download and organize your media, then you want to know how to manage your own manga in Tachiyomi. --- # Local manga +If you like to download and organize your media, then you want to know how to manage your own manga in Tachiyomi. + ## Creating local manga 1. Create a folder named `local` in the `/Tachiyomi/` folder. > The `/Tachiyomi/` folder is located in the root of phone's **internal storage** or **external SD card** and it's **not related** to the `eu.kanade.tachiyomi/` folder or the download location in the settings. -2. Place correctly structured manga inside `/Tachiyomi/local/`. +1. Place correctly structured manga inside `/Tachiyomi/local/`. > If adding manga in folders it is recommended to add a file named `.nomedia` to the local folder so images do not show up in the gallery. -3. You should now be able to access the manga in _explore_Browse → **Local source**. +1. You should now be able to access the manga in _explore_Browse → **Local source**. If you add more chapters then you'll have to manually refresh the chapter list (by pulling down the list). -Supported chapter formats are folders with pictures inside (such as `.jpg`, `.png`, etc), `ZIP`/`CBZ`, `RAR`/`CBR` and `EPUB`. But expect better performance with directories and `ZIP`/`CBZ`. +Supported chapter formats are folders with pictures inside (such as `.jpg`, `.png`, etc), `ZIP`/`CBZ`, `RAR`/`CBR` and `EPUB`. +But expect better performance with directories and `ZIP`/`CBZ`. Remember to give the app storage permissions on **Android 6** and newer. ### Folder Structure -Tachiyomi requires a specific folder structure for local manga to be correctly processed. Local manga will be read from the `Tachiyomi/local` folder. Each manga must have a `Manga` folder and a `Chapter` folder. Images will then go into the chapter folder. See below for more information on archive files. You can refer to the following example: +Tachiyomi requires a specific folder structure for local manga to be correctly processed. +Local manga will be read from the `Tachiyomi/local` folder. +Each manga must have a `Manga` folder and a `Chapter` folder. +Images will then go into the chapter folder. +See below for more information on archive files. +You can refer to the following example: #### Example (Folder) @@ -64,11 +71,15 @@ Tachiyomi requires a specific folder structure for local manga to be correctly p | image_n ``` -Tachiyomi will see four chapters in a single manga. The path to the folder with images must contain both the manga title and the chapter name (as seen above). +Tachiyomi will see four chapters in a single manga. +The path to the folder with images must contain both the manga title and the chapter name (as seen above). ### Archive Files -Archive files such as `ZIP`/`CBZ` are supported but the folder structure inside is not. Any folders inside the archive file are ignored. You must place the archive inside the `Manga` folder where the name will become the `Chapter` title. All images inside the archive regardless of folder structure will become pages for that chapter. +Archive files such as `ZIP`/`CBZ` are supported but the folder structure inside is not. +Any folders inside the archive file are ignored. +You must place the archive inside the `Manga` folder where the name will become the `Chapter` title. +All images inside the archive regardless of folder structure will become pages for that chapter. Example (ZIP) @@ -94,13 +105,19 @@ Example (ZIP) ### Editing local manga details -It is possible to add details to local manga. Like manga from other catalogs, you add information about the manga such as the author, artist, description, and genre tags. +It is possible to add details to local manga. +Like manga from other catalogs, you add information about the manga such as the author, artist, description, and genre tags. -To import details along with your local manga, you have to create a JSON file. It can be named anything but it must be placed within the **Manga** folder. A standard file name is `details.json`. This file will contain the extended details about the manga in the `JSON` format. You can see the example below on how to build the file. Once the file is there, the app should load the data when you first open the manga or you can pull down to refresh the details. +To import details along with your local manga, you have to create a JSON file. +It can be named anything but it must be placed within the **Manga** folder. +A standard file name is `details.json`. +This file will contain the extended details about the manga in the `JSON` format. +You can see the example below on how to build the file. +Once the file is there, the app should load the data when you first open the manga or you can pull down to refresh the details. You can copy the following example and edit the details as needed: -``` +```json { "title": "Example Title", "author": "Example Author", @@ -111,11 +128,13 @@ You can copy the following example and edit the details as needed: "_status values": ["0 = Unknown", "1 = Ongoing", "2 = Completed", "3 = Licensed", "4 = Publishing finished", "5 = Cancelled", "6 = On hiatus"] } ``` - +::: tip If you don't want to manually create the `details.json` file, you can alternatively use [this tool.](https://tachi-local.netlify.app/?utm\_source=tachi-website\&utm\_medium=referral\&utm\_campaign=tachi-website) +::: ### Using a custom cover image It is also possible to use a custom image as a cover for each local manga. -To do this, you only need to place the image file, that needs to be named `cover.jpg`, in the root of the manga folder. The app will then use your custom image in the local source listing. +To do this, you only need to place the image file, that needs to be named `cover.jpg`, in the root of the manga folder. +The app will then use your custom image in the local source listing. diff --git a/src/docs/guides/reader-settings.md b/src/docs/guides/reader-settings.md index 5fe3c7e5..47074687 100644 --- a/src/docs/guides/reader-settings.md +++ b/src/docs/guides/reader-settings.md @@ -1,9 +1,8 @@ --- +title: Reader settings description: This section relates to the reading experience in the app and navigating the reader. --- # Reader settings Page too complex to port in only a few minutes. - -[![Github All Releases](https://img.shields.io/github/downloads/tachiyomiorg/tachiyomi/total.svg?style=flat)](https://tachiyomi.org/download) \ No newline at end of file diff --git a/src/docs/guides/source-migration.md b/src/docs/guides/source-migration.md index 95bcf0fd..1ee63ea2 100644 --- a/src/docs/guides/source-migration.md +++ b/src/docs/guides/source-migration.md @@ -1,48 +1,36 @@ --- -description: >- - Migration is the process of moving manga between sources without losing - progress. This is most often used when a source is no longer accessible or - another source is more up-to-date. +title: Source migration +description: Migration is the process of moving manga between sources without losing progress. This is most often used when a source is no longer accessible or another source is more up-to-date. --- # Source migration - Always make sure to have a backup in case anything unexpected occurs. - - Downloaded chapter(s) do not transfer with migrations. -Migrations with downloaded chapter(s) may leave the download behind. You will need to remove these manually with a file manager. - - - +Migrations with downloaded chapter(s) may leave the download behind. +You will need to remove these manually with a file manager. **Migrating from Manga** 1. Tap into a **Manga** you would like to migrate. -2. Go to Overflow and tap Migrate. +1. Go to Overflow and tap Migrate. > **Tachiyomi** will do a global search of all the sources you have installed and enabled. -3. Select the **Source** that you'd like to migrate _to_ by tapping the **Manga** thumbnail. -4. Choose which data you want to transfer over, and you're done. - - +1. Select the **Source** that you'd like to migrate _to_ by tapping the **Manga** thumbnail. +1. Choose which data you want to transfer over, and you're done. **Migrating from Source** 1. Tap into Browse on the bottom navbar. -2. Press the Migrate tab at the top next to Extensions. -3. Select the **Source** that you'd like to migrate _from_. -4. Tap the **Manga** you'd like to migrate _from_ the **Source**. +1. Press the Migrate tab at the top next to Extensions. +1. Select the **Source** that you'd like to migrate _from_. +1. Tap the **Manga** you'd like to migrate _from_ the **Source**. > **Tachiyomi** will do a global search of all the sources you have installed and enabled. -5. Select the **Source** you'd like to migrate _to_ by tapping the **Manga** thumbnail. -6. Choose which data you want to transfer over, and you're done. - - - +1. Select the **Source** you'd like to migrate _to_ by tapping the **Manga** thumbnail. +1. Choose which data you want to transfer over, and you're done. **Searching only pinned sources** @@ -52,68 +40,55 @@ To do this, go to **More → Settings → Browse** then toggle the **Only includ Pin sources in Browse using the pin icon next to the source name. - - - **Migrating multiple Manga** 1. Tap **Settings** → **Sources** → **Source migration**. -2. Select the **Source** you'd like to migrate _from_ and select **All**. -3. Select the **Sources** that you'd like to migrate _to_ and search by and tap the arrow at the bottom right. -4. Choose which data you want to transfer over. -5. Wait until all your **Manga** is found and hit the done at the top and you're done. +1. Select the **Source** you'd like to migrate _from_ and select **All**. +1. Select the **Sources** that you'd like to migrate _to_ and search by and tap the arrow at the bottom right. +1. Choose which data you want to transfer over. +1. Wait until all your **Manga** is found and hit the done at the top and you're done. > If a manga is not found, or is wrong you can manually search it by pressing Overflow → **Search manually**. - - **Migrating a single Manga** 1. Tap into a **Manga** in your Library. -2. Tap **Overflow** → **Migrate manga**. -3. Select the **Sources** you'd like to search and migrate _to_ and hit the arrow at the bottom right. -4. Wait until it is found and select _done_ in the top right and you're done. +1. Tap **Overflow** → **Migrate manga**. +1. Select the **Sources** you'd like to search and migrate _to_ and hit the arrow at the bottom right. +1. Wait until it is found and select _done_ in the top right and you're done. > If a manga is not found, or is wrong you can manually search it by pressing Overflow → **Search manually** - - **Migrating from Library** 1. Tap into **Library**. -2. Tap **Overflow** → **Source migration**. -3. Select the **Source** you'd like to migrate _from_ and select **All**. -4. Select the **Sources** that you'd like to migrate _to_ and search by and tap the arrow labeled Migrate. at the bottom right. -5. Choose which data you want to transfer over. -6. Wait until all your **Manga** is found and hit the done at the top and you're done. +1. Tap **Overflow** → **Source migration**. +1. Select the **Source** you'd like to migrate _from_ and select **All**. +1. Select the **Sources** that you'd like to migrate _to_ and search by and tap the arrow labeled Migrate at the bottom right. +1. Choose which data you want to transfer over. +1. Wait until all your **Manga** is found and hit the done at the top and you're done. > If a manga is not found, or is wrong you can manually search it by pressing **Overflow** → **Search manually**. - - **Migrating from Source** 1. Tap into Browse on the bottom navbar. -2. Press the Migrate tab at the top next to Extensions. -3. Select the **Source** that you'd like to migrate _from_. -4. Select the **Source** you'd like to migrate _from_ and select **All**. -5. Select the **Sources** that you'd like to migrate _to_ and search by and tap the arrow labeled Migrate at the bottom right. -6. Choose which data you want to transfer over. -7. Wait until all your **Manga** is found and hit the done at the top and you're done. +1. Press the Migrate tab at the top next to Extensions. +1. Select the **Source** that you'd like to migrate _from_. +1. Select the **Source** you'd like to migrate _from_ and select **All**. +1. Select the **Sources** that you'd like to migrate _to_ and search by and tap the arrow labeled Migrate at the bottom right. +1. Choose which data you want to transfer over. +1. Wait until all your **Manga** is found and hit the done at the top and you're done. > If a manga is not found, or is wrong you can manually search it by pressing **Overflow** → **Search manually**. - - **Instructions** 1. Tap into **Library**. -2. Tap **Overflow** → **Source migration**. -3. Select the **Source** you'd like to migrate _from_ and select **All**. -4. Select the **Sources** that you'd like to migrate _to_ and search by and tap the arrow at the bottom right. -5. Choose which data you want to transfer over. -6. Wait until all your **Manga** is found and hit the done at the top and you're done. +1. Tap **Overflow** → **Source migration**. +1. Select the **Source** you'd like to migrate _from_ and select **All**. +1. Select the **Sources** that you'd like to migrate _to_ and search by and tap the arrow at the bottom right. +1. Choose which data you want to transfer over. +1. Wait until all your **Manga** is found and hit the done at the top and you're done. > If a manga is not found, or is wrong you can manually search it by pressing **Overflow** → **Search manually**. - - diff --git a/src/docs/guides/tracking.md b/src/docs/guides/tracking.md index f89a1a24..572e6983 100644 --- a/src/docs/guides/tracking.md +++ b/src/docs/guides/tracking.md @@ -1,7 +1,6 @@ --- -description: >- - Tracking helps you automatically send read manga chapters to supported - trackers, so you can keep track of what and when you read it online. +title: Tracking +description: Tracking helps you automatically send read manga chapters to supported trackers, so you can keep track of what and when you read it online. --- # Tracking @@ -14,7 +13,10 @@ Tracking is currently supported on [MyAnimeList](https://myanimelist.net/), [Ani * After being offline, Tachiyomi will send progress made offline to the tracker. * Tachiyomi will attempt to automatically set the start date when starting a manga. * Tachiyomi will also set the finished date and reading status to completed if the read chapter is equal to the tracker's total chapters. -* Tracking is one-way. Meaning updating status in Tachiyomi will update the tracker, but updating status in the tracker will not update Tachiyomi. +* Tracking is one-way. + * Meaning updating status in Tachiyomi will update the tracker, but updating status in the tracker will not update Tachiyomi. + +
Unattended tracking is also supported for [Komga](https://komga.org/), and works a bit differently from other trackers: @@ -23,34 +25,36 @@ Unattended tracking is also supported for [Komga](https://komga.org/), and works * Tracking only works for the Komga sources. * Tracking is two-way, and local chapters will be marked as read. * You must read the last page of a chapter to mark the chapter as read and track it. -* If you mark a chapter as read manually, the tracker will not be updated right away. You can update the tracker status on the server-side by opening the tracker sheet. -* You can configure Tachiyomi to automatically track manga when adding to the library. Go to **More → Settings → Tracking** and then **Track silently when adding manga to the library** +* If you mark a chapter as read manually, the tracker will not be updated right away. + * You can update the tracker status on the server-side by opening the tracker sheet. +* You can configure Tachiyomi to automatically track manga when adding to the library. + * Go to **More → Settings → Tracking** and then **Track silently when adding manga to the library** -### How do I login into trackers? +## How do I login into trackers? 1. Go to **More → Settings → Tracking** to Login -2. Tap the tracker you would like to login to, it will automatically open the browser and lead you through the login process. +1. Tap the tracker you would like to login to, it will automatically open the browser and lead you through the login process. -### How do I set up tracking for each manga? +## How do I set up tracking for each manga? 1. Go to the manga you want to track. -2. Tap the Tracking button. -3. Tap **Add tracking** on the service you want to track the manga on. +1. Tap the Tracking button. +1. Tap **Add tracking** on the service you want to track the manga on. > _You can also change the search query if there is no match._ -### How do I log in with Kitsu? +## How do I log in with Kitsu? To log in with Kitsu, you need to use your email address as your username. -### Why am I unable to find a manga in MAL's search results? - -If you cannot find a manga by name, you can look it up on MAL and then search for it in Tachiyomi using the following format: `id:`. You can also search for a manga on your MAL profile list by searching in the following format: `my:`. +## Why am I unable to find a manga in MAL's search results? +If you cannot find a manga by name, you can look it up on MAL and then search for it in Tachiyomi using the following format: `id:`. +You can also search for a manga on your MAL profile list by searching in the following format: `my:`. Related GitHub issue: [#65](https://github.com/tachiyomiorg/tachiyomi/issues/65) +## How do I see which manga I have or have not tracked in my library? -### How do I see which manga I have or have not tracked in my library? - -Go to Library → Tap Filter on the top right → Go to the Filter tab and toggle Tracked. If you are logged into more than one tracker, toggle the tracker you want to include or exclude. +Go to Library → Tap Filter on the top right → Go to the Filter tab and toggle Tracked. +If you are logged into more than one tracker, toggle the tracker you want to include or exclude. diff --git a/src/docs/guides/troubleshooting.md b/src/docs/guides/troubleshooting.md index 9e9c3c4d..4a7e2203 100644 --- a/src/docs/guides/troubleshooting.md +++ b/src/docs/guides/troubleshooting.md @@ -1,7 +1,8 @@ --- +title: Troubleshooting description: This page is for when you encounter a problem with a source or the app. --- # Troubleshooting -Page too complex to port in only a few minutes. \ No newline at end of file +Page too complex to port in only a few minutes. diff --git a/src/download.md b/src/download.md index 9aa84066..77c6ef73 100644 --- a/src/download.md +++ b/src/download.md @@ -1,3 +1,11 @@ +--- +title: Download +description: WIP +--- + # Download -![GitHub all releases](https://img.shields.io/github/downloads/tachiyomiorg/tachiyomi/total?style=social) +WIP + + +![GitHub all releases](https://img.shields.io/github/downloads/tachiyomiorg/tachiyomi/total?label=downloads&labelColor=27303D&color=0D1117&logo=github&logoColor=FFFFFF&style=flat) diff --git a/src/extensions.md b/src/extensions.md index e69de29b..62d9f8f5 100644 --- a/src/extensions.md +++ b/src/extensions.md @@ -0,0 +1,8 @@ +--- +title: Extensions +description: WIP +--- + +# Extensions + +WIP diff --git a/src/forks/index.md b/src/forks/index.md index ade99b89..41904def 100644 --- a/src/forks/index.md +++ b/src/forks/index.md @@ -25,7 +25,8 @@ Some features include: ## [TachiyomiAZ](tachiyomiaz) -This fork is based on **[TachiyomiEH](https://github.com/NerdNumber9/TachiyomiEH)**, it has most features and fixes from **Tachiyomi**, as well as features from **[TachiyomiJ2K](tachiyomij2k)**. It has decided to keep the old hamburger menu style of navigation, compared to the other forks that have moved to the new bottom navigation style. +This fork is based on **[TachiyomiEH](https://github.com/NerdNumber9/TachiyomiEH)**, it has most features and fixes from **Tachiyomi**, as well as features from **[TachiyomiJ2K](tachiyomij2k)**. +It has decided to keep the old hamburger menu style of navigation, compared to the other forks that have moved to the new bottom navigation style. Some features include: * Built in sources of many popular hentai sources with additional features. @@ -35,9 +36,11 @@ Some features include: ## [TachiyomiSY](tachiyomisy) -This fork is based on [TachiyomiAZ](tachiyomiaz) and adds quite a lot of unique features. It has the same new UI as the latest Tachiyomi version. And at the same time, it also shares quite a lot of features from both **Tachiyomi** and [TachiyomiJ2K](tachiyomij2k). +This fork is based on [TachiyomiAZ](tachiyomiaz) and adds quite a lot of unique features. +It has the same new UI as the latest Tachiyomi version. +And at the same time, it also shares quite a lot of features from both **Tachiyomi** and [TachiyomiJ2K](tachiyomij2k). Some features include: * Enhanced pages for certain sources * Latest tab preview configurable up to five sources -* Ability to enable and disable hentai specific features \ No newline at end of file +* Ability to enable and disable hentai specific features diff --git a/src/forks/neko.md b/src/forks/neko.md index d2757a85..aabc12f0 100644 --- a/src/forks/neko.md +++ b/src/forks/neko.md @@ -1,14 +1,19 @@ +--- +title: Neko +description: WIP +--- + # Neko -This is a [MangaDex](https://mangadex.org/) specific fork of **Tachiyomi** and TachiyomiJ2K. This contains features specific to **MangaDex** that those versions cannot offer. It also features almost every feature that **J2K** has except for extensions (aka other sources), custom covers, and local manga. - -### Download +This is a [MangaDex](https://mangadex.org/) specific fork of **Tachiyomi** and TachiyomiJ2K. +This contains features specific to **MangaDex** that those versions cannot offer. +It also features almost every feature that **J2K** has except for extensions (aka other sources), custom covers, and local manga. +## Download Requires **Android 7.0** or higher. - -### Mangadex specific features: +## Mangadex specific features: * Supports native login to **MangaDex** and supports 2FA * MDList support @@ -17,11 +22,11 @@ Requires **Android 7.0** or higher. * MDList tracked manga can be auto-marked read in-app after reading on the website * Ability to filter chapters and skip by scanlator group -### Credits +## Credits * [Inorichi](https://github.com/inorichi/) for making the original **Tachiyomi** * [Jays2Kings](https://github.com/Jays2Kings/) for the wonderful new UI of **J2K** -### Disclaimer +## Disclaimer The developer of this application does not have any affiliation with the content providers available. diff --git a/src/forks/tachiyomiaz.md b/src/forks/tachiyomiaz.md index 4f7ecf66..24fbaaa8 100644 --- a/src/forks/tachiyomiaz.md +++ b/src/forks/tachiyomiaz.md @@ -1,26 +1,24 @@ +--- +title: TachiyomiAZ +description: WIP +--- + # TachiyomiAZ -This hentai-focused fork is based on **TachiyomiEH**, it has most features and fixes from **Tachiyomi**, as well as features from **TachiyomiJ2K**. It has decided to keep the hamburger menu style of navigation, compared to the other forks that are moving to the new bottom navigation style. - -### Download - - +This hentai-focused fork is based on **TachiyomiEH**, it has most features and fixes from **Tachiyomi**, as well as features from **TachiyomiJ2K**. +It has decided to keep the hamburger menu style of navigation, compared to the other forks that are moving to the new bottom navigation style. +## Download Requires **Android 5.0** or higher. - - - - Requires **Android 5.0** or higher. +## Features +### Special Sources - -### Features - -**Special Sources** (integrated plus added features) +(integrated plus added features) * E-Hentai/ExHentai * nHentai @@ -29,13 +27,15 @@ Requires **Android 5.0** or higher. * HBrowse * Perv Eden -**Delegated Sources** (Sources with added features if installed) +### Delegated Sources + +(Sources with added features if installed) * Puruin * Tsumino * HentaiCafe (Foolside) -**From EH:** +### From EH: * Save Searches for use later * AutoScroll @@ -48,7 +48,7 @@ Requires **Android 5.0** or higher. * Batch import E-Hentai/ExHentai URLs (import single URLs by pasting them into the source search box) * Automatic CAPTCHA solving -**From EH and fixed/changed:** +### From EH and fixed/changed: * Auto Migration (Originally from EH, it was then improved in J2k, and we have reintegrated the J2k version) * Merged Sources (Merge 2 or more versions of a manga to get chapters from all of them) @@ -59,12 +59,12 @@ Requires **Android 5.0** or higher. * Tri-state filter when filtering in library * Random bugfixes -**Original AZ Features:** +### Original AZ Features: * Maintained hamburger navigation * Grid view corner rounding configuration * Manga recommendations -### Disclaimer +## Disclaimer The developer of this application does not have any affiliation with the content providers available. diff --git a/src/forks/tachiyomij2k.md b/src/forks/tachiyomij2k.md index 809c53fc..15df1d74 100644 --- a/src/forks/tachiyomij2k.md +++ b/src/forks/tachiyomij2k.md @@ -1,16 +1,19 @@ +--- +title: TachiyomiJ2K +description: WIP +--- + # TachiyomiJ2K **TachiyomiJ2K** is maintained by [**Jays2Kings**](https://github.com/Jays2Kings). This fork takes a new approach to the design of the base app along with several other enhancements. -### Download - +## Download Requires **Android 6.0** or higher. - -### Features +## Features For a full list of features, visit the GitHub page. @@ -40,6 +43,6 @@ For a full list of features, visit the GitHub page. * **Expanding manga thumbnails** * **A lot more Material Design 2 additions** -### Disclaimer +## Disclaimer The developer of this application does not have any affiliation with the content providers available. diff --git a/src/forks/tachiyomisy.md b/src/forks/tachiyomisy.md index 4505a2a0..377070ba 100644 --- a/src/forks/tachiyomisy.md +++ b/src/forks/tachiyomisy.md @@ -1,23 +1,18 @@ +--- +title: TachiyomiSY +description: WIP +--- + # TachiyomiSY This fork is based on TachiyomiAZ and adds quite a few unique features, it also has new features from the latest Tachiyomi version as well as from other forks such as TachiyomiJ2K. ### Download - - - Requires **Android 6.0** or higher. - - - - Requires **Android 6.0** or higher. - - - ### Features * Uses the new **Tachiyomi** UI diff --git a/src/index.md b/src/index.md index 09da40e1..b019aea8 100644 --- a/src/index.md +++ b/src/index.md @@ -26,4 +26,3 @@ features: details: A configurable reader with multiple reading modes, custom color filters, and other settings. icon: --- - diff --git a/src/privacy.md b/src/privacy.md index 4f1622c6..2f78bcf7 100644 --- a/src/privacy.md +++ b/src/privacy.md @@ -1,15 +1,23 @@ +--- +title: Privacy policy +description: WIP +--- -# Privacy Policy +# Privacy policy -Tachiyomi is an Open Source app. This SERVICE is provided at no cost and is intended for use as is. +Tachiyomi is an Open Source app. +This SERVICE is provided at no cost and is intended for use as is. This page details our policies with the collection, use, and disclosure of Personal Information if anyone decided to use our Service. -If you choose to use our Service, then you agree to the collection and use of information in relation to this policy. The Personal Information that we collect is used for providing and improving the Service. We will not use or share your information with anyone except as described in this Privacy Policy. +If you choose to use our Service, then you agree to the collection and use of information in relation to this policy. +The Personal Information that we collect is used for providing and improving the Service. +We will not use or share your information with anyone except as described in this Privacy Policy. ## Information Collection and Use -For a better experience, while using our Service, we may require you to provide us with certain personally identifiable information. The information that we request will be retained by us and used as described in this privacy policy. +For a better experience, while using our Service, we may require you to provide us with certain personally identifiable information. +The information that we request will be retained by us and used as described in this privacy policy. Links to the privacy policy of third-party service providers used by the app: * [Google Analytics for Firebase](https://firebase.google.com/policies/analytics) @@ -17,7 +25,8 @@ Links to the privacy policy of third-party service providers used by the app: ### Log Data -In a case of an error in the app, the Service automatically collects data and information called Log Data. This Log Data may include information including your device name, operating system version, the configuration of the app when utilizing our Service, the time and date of your use of the Service, and other statistics. +In a case of an error in the app, the Service automatically collects data and information called Log Data. +This Log Data may include information including your device name, operating system version, the configuration of the app when utilizing our Service, the time and date of your use of the Service, and other statistics. This can be disabled within the app. @@ -29,16 +38,21 @@ For more information, you can refer to [How Google uses data when you use our pa ## External Links -This Service contains links to other sites. If you click on a third-party link, you will be directed to that site. Note that these external sites are not operated by us. Therefore, we strongly advise you to review the Privacy Policy of these websites. We have no control over and assume no responsibility for the content, privacy policies, or practices of any third-party sites or services. +This Service contains links to other sites. +If you click on a third-party link, you will be directed to that site. +Note that these external sites are not operated by us. +Therefore, we strongly advise you to review the Privacy Policy of these websites. +We have no control over and assume no responsibility for the content, privacy policies, or practices of any third-party sites or services. This includes the use of external tracking services (e.g. MyAnimeList). ## Changes to This Privacy Policy -We may periodically update our Privacy Policy. Thus, you are advised to review this page periodically for any changes. +We may periodically update our Privacy Policy. +Thus, you are advised to review this page periodically for any changes. The current iteration of this policy is effective as of December 15, 2021. ## Contact Us -If you have any questions or suggestions about this Privacy Policy, do not hesitate to reach out to us on [our Discord server](https://discord.gg/tachiyomi). \ No newline at end of file +If you have any questions or suggestions about this Privacy Policy, do not hesitate to reach out to us on [our Discord server](https://discord.gg/tachiyomi).