diff --git a/.markdownlint.json b/.markdownlint.json index 12ccb3cf..9f66c897 100644 --- a/.markdownlint.json +++ b/.markdownlint.json @@ -1,10 +1,3 @@ { - "extends": "markdownlint/style/prettier", - "list-marker-space": { - "ul_multi": 3, - "ul_single": 3 - }, - "ul-indent": { - "indent": 4 - } + "extends": "markdownlint/style/prettier" } diff --git a/.markdownlintignore b/.markdownlintignore new file mode 100644 index 00000000..76077685 --- /dev/null +++ b/.markdownlintignore @@ -0,0 +1,2 @@ +node_modules +README.md diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index b3aeaab9..d771dcef 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -68,9 +68,9 @@ members of the project's leadership. ## Attribution This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, -available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html +available at [https://www.contributor-covenant.org/version/1/4/code-of-conduct.html](https://www.contributor-covenant.org/version/1/4/code-of-conduct.html) [homepage]: https://www.contributor-covenant.org For answers to common questions about this code of conduct, see -https://www.contributor-covenant.org/faq +[https://www.contributor-covenant.org/faq](https://www.contributor-covenant.org/faq) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e90bcc15..1732786f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -75,7 +75,4 @@ It is also recommended you lint your files before the PR. Thank you to all the people who have already contributed! - - - - +[![List of Contributors](https://contrib.rocks/image?repo=tachiyomiorg/website 'List of Contributors')](https://github.com/tachiyomiorg/website/graphs/contributors) diff --git a/package.json b/package.json index c2ce7f71..069beaec 100644 --- a/package.json +++ b/package.json @@ -17,7 +17,7 @@ "docs:preview": "vitepress preview src", "format": "prettier --check --write .", "format:fail": "prettier --check .", - "lint:mdl": "markdownlint \"**/*.md\" \".github/**/*.md\" --enable sentences-per-line" + "lint:mdl": "markdownlint \"**/*.md\" \".github/**/*.md\" --enable sentences-per-line --disable MD025" }, "devDependencies": { "markdownlint": "^0.29.0", diff --git a/src/docs/contribution.md b/src/docs/contribution.md index aa32f186..f3a972b0 100644 --- a/src/docs/contribution.md +++ b/src/docs/contribution.md @@ -7,42 +7,42 @@ description: Find out how to help translate or build the app and extensions. 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. * Current active repository * Planned rewrite repository -### Extensions +### 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 -## Translation +## 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**. -**Helpful links** +### Helpful links * [Translators guide](https://docs.weblate.org/en/latest/user/translating.html) * [Secondary-languages](https://docs.weblate.org/en/latest/user/profile.html#secondary-languages) * [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 fa0753e2..7d44d021 100644 --- a/src/docs/faq/application/android-11+.md +++ b/src/docs/faq/application/android-11+.md @@ -19,7 +19,7 @@ These include deleting chapters, library load times, accessing the folders outsi 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. -``` +```bash adb shell cmd appops set eu.kanade.tachiyomi android:legacy_storage allow ``` diff --git a/src/docs/faq/application/browse/index.md b/src/docs/faq/application/browse/index.md index 6a47bf40..d63adbd5 100644 --- a/src/docs/faq/application/browse/index.md +++ b/src/docs/faq/application/browse/index.md @@ -7,15 +7,15 @@ description: WIP ## 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: @@ -27,11 +27,11 @@ Tips to find your manga 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). diff --git a/src/docs/faq/application/reader.md b/src/docs/faq/application/reader.md index 0312166f..718e844b 100644 --- a/src/docs/faq/application/reader.md +++ b/src/docs/faq/application/reader.md @@ -13,7 +13,7 @@ Aside from network issues, sometimes Tachiyomi does not register the image as ex 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? diff --git a/src/docs/faq/extensions.md b/src/docs/faq/extensions.md index a81d12d9..489de41b 100644 --- a/src/docs/faq/extensions.md +++ b/src/docs/faq/extensions.md @@ -18,7 +18,7 @@ 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? @@ -34,7 +34,7 @@ Make sure it is not on the removed extensions list [here](https://github.com/tac You can find the list of extensions to download [here](https://tachiyomi.org/extensions/) -
+--- ### How do I allow third-party installations? @@ -48,7 +48,7 @@ In _older_ versions of **Android**, you only need to enable **Unknown sources** 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? @@ -77,13 +77,13 @@ A list of extensions that have been removed is available [here](https://github.c 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? All of them have been split. -
+--- ### Why does my multisource extension show up as obsolete? @@ -91,7 +91,7 @@ The multisource extension is obsolete because it has been split. The multisource extension has been removed from the repository. It is not actually obsolete. -
+--- ### How do I move to a split extension? @@ -99,13 +99,13 @@ Install the extension that your manga is from, and then uninstall the multisourc 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? diff --git a/src/docs/guides/backups.md b/src/docs/guides/backups.md index ba0e75d2..07c00375 100644 --- a/src/docs/guides/backups.md +++ b/src/docs/guides/backups.md @@ -27,20 +27,20 @@ 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. -## Forks information +## 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. diff --git a/src/docs/guides/categories.md b/src/docs/guides/categories.md index 7d242bf9..3b22f2a3 100644 --- a/src/docs/guides/categories.md +++ b/src/docs/guides/categories.md @@ -9,7 +9,7 @@ description: Categories help you store your bookmarked manga in custom tabs, whi 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. @@ -17,7 +17,7 @@ To create a category, follow the steps below. 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. @@ -25,7 +25,7 @@ To edit a category follow the steps below. 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. @@ -35,7 +35,7 @@ To do this, follow the steps below. 1. Go to More → Categories. 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. @@ -43,22 +43,22 @@ To delete a category, follow the steps below. 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. 1. Press the Set categories button. -1. Select which category or categories you want it in and press **OK**. +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. 1. Press the Set categories button. -1. Deselect the category or categories you want to remove it from and press **OK**. +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 facdfea1..da5f9bff 100644 --- a/src/docs/guides/getting-started.md +++ b/src/docs/guides/getting-started.md @@ -5,12 +5,12 @@ 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. -## 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. @@ -18,7 +18,7 @@ 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. diff --git a/src/docs/guides/local-manga.md b/src/docs/guides/local-manga.md index eb402736..6e79fe30 100644 --- a/src/docs/guides/local-manga.md +++ b/src/docs/guides/local-manga.md @@ -9,10 +9,10 @@ If you like to download and organize your media, then you want to know how to ma ## Creating local manga -1. Create a folder named `local` in the `/Tachiyomi/` folder. +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. -1. 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. 1. You should now be able to access the manga in _explore_Browse → **Local source**. @@ -24,7 +24,7 @@ But expect better performance with directories and `ZIP`/`CBZ`. Remember to give the app storage permissions on **Android 6** and newer. -### Folder Structure +### 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. @@ -35,7 +35,7 @@ You can refer to the following example: #### Example (Folder) -``` +```txt /sdcard/Tachiyomi/local └───[the series title] | cover.jpg @@ -53,7 +53,7 @@ You can refer to the following example: | image_n ``` -``` +```txt /storage/18F5-2C11/Tachiyomi/local └───[the series title] | cover.jpg @@ -74,7 +74,7 @@ You can refer to the following example: 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 Archive files such as `ZIP`/`CBZ` are supported but the folder structure inside is not. Any folders inside the archive file are ignored. @@ -83,7 +83,7 @@ All images inside the archive regardless of folder structure will become pages f Example (ZIP) -``` +```txt /sdcard/Tachiyomi/local └───[the series title] | cover.jpg @@ -101,9 +101,9 @@ Example (ZIP) | image_n.jpg ``` -## Advanced +## Advanced -### Editing local manga details +### 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. @@ -132,7 +132,7 @@ You can copy the following example and edit the details as needed: 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 +### Using a custom cover image It is also possible to use a custom image as a cover for each local manga. diff --git a/src/docs/guides/source-migration.md b/src/docs/guides/source-migration.md index 1ee63ea2..907ba607 100644 --- a/src/docs/guides/source-migration.md +++ b/src/docs/guides/source-migration.md @@ -12,7 +12,7 @@ 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. -**Migrating from Manga** +## Migrating from Manga 1. Tap into a **Manga** you would like to migrate. 1. Go to Overflow and tap Migrate. @@ -21,7 +21,7 @@ You will need to remove these manually with a file manager. 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** +## Migrating from Source 1. Tap into Browse on the bottom navbar. 1. Press the Migrate tab at the top next to Extensions. @@ -32,7 +32,7 @@ You will need to remove these manually with a file manager. 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** +## Searching only pinned sources You can restrict global searching to pinned sources if you wish to declutter your search. @@ -40,7 +40,7 @@ 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** +## Migrating multiple Manga 1. Tap **Settings** → **Sources** → **Source migration**. 1. Select the **Source** you'd like to migrate _from_ and select **All**. @@ -50,16 +50,16 @@ Pin sources in Browse using the pin icon next to the source name. > If a manga is not found, or is wrong you can manually search it by pressing Overflow → **Search manually**. -**Migrating a single Manga** +## Migrating a single Manga 1. Tap into a **Manga** in your Library. 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. +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** +## Migrating from Library 1. Tap into **Library**. 1. Tap **Overflow** → **Source migration**. @@ -70,7 +70,7 @@ Pin sources in Browse using the pin icon next to the source name. > If a manga is not found, or is wrong you can manually search it by pressing **Overflow** → **Search manually**. -**Migrating from Source** +## Migrating from Source 2 1. Tap into Browse on the bottom navbar. 1. Press the Migrate tab at the top next to Extensions. @@ -82,7 +82,7 @@ Pin sources in Browse using the pin icon next to the source name. > If a manga is not found, or is wrong you can manually search it by pressing **Overflow** → **Search manually**. -**Instructions** +## Instructions 1. Tap into **Library**. 1. Tap **Overflow** → **Source migration**. diff --git a/src/docs/guides/tracking.md b/src/docs/guides/tracking.md index 572e6983..53556890 100644 --- a/src/docs/guides/tracking.md +++ b/src/docs/guides/tracking.md @@ -16,7 +16,7 @@ Tracking is currently supported on [MyAnimeList](https://myanimelist.net/), [Ani * 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: @@ -30,12 +30,12 @@ Unattended tracking is also supported for [Komga](https://komga.org/), and works * 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 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. 1. Tap the Tracking button. @@ -43,18 +43,18 @@ Unattended tracking is also supported for [Komga](https://komga.org/), and works > _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? +## 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. diff --git a/src/forks/neko.md b/src/forks/neko.md index aabc12f0..319c680b 100644 --- a/src/forks/neko.md +++ b/src/forks/neko.md @@ -13,7 +13,7 @@ It also features almost every feature that **J2K** has except for extensions (ak Requires **Android 7.0** or higher. -## Mangadex specific features: +## Mangadex specific features * Supports native login to **MangaDex** and supports 2FA * MDList support @@ -22,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 24fbaaa8..f27e461d 100644 --- a/src/forks/tachiyomiaz.md +++ b/src/forks/tachiyomiaz.md @@ -14,7 +14,7 @@ Requires **Android 5.0** or higher. Requires **Android 5.0** or higher. -## Features +## Features ### Special Sources @@ -35,7 +35,7 @@ Requires **Android 5.0** or higher. * 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 15df1d74..54c564f3 100644 --- a/src/forks/tachiyomij2k.md +++ b/src/forks/tachiyomij2k.md @@ -13,7 +13,7 @@ This fork takes a new approach to the design of the base app along with several Requires **Android 6.0** or higher. -## Features +## Features For a full list of features, visit the GitHub page. @@ -43,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 377070ba..3c6ffb8e 100644 --- a/src/forks/tachiyomisy.md +++ b/src/forks/tachiyomisy.md @@ -7,13 +7,13 @@ description: WIP 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 +## Download Requires **Android 6.0** or higher. Requires **Android 6.0** or higher. -### Features +## Features * Uses the new **Tachiyomi** UI * Enhanced pages for certain sources @@ -32,11 +32,11 @@ Requires **Android 6.0** or higher. * Enhanced views for internal and delegated sources * Numerous features from TachiyomiAZ -### Credits +## Credits * [She11Shocked](https://github.com/she11sh0cked/) for the extra tracking, filter, recommendation features, and a ton more. * [az4521](https://github.com/az4521) for the base recommendations and **AZ**. -### Disclaimer +## Disclaimer The developer of this application does not have any affiliation with the content providers available.