diff --git a/website/src/.vitepress/config/navigation/sidebar.ts b/website/src/.vitepress/config/navigation/sidebar.ts index e6c35ad3..e703aa61 100644 --- a/website/src/.vitepress/config/navigation/sidebar.ts +++ b/website/src/.vitepress/config/navigation/sidebar.ts @@ -91,7 +91,17 @@ function defaultSidebar() { { text: "Backups", link: "/docs/guides/backups" }, { text: "Tracking", link: "/docs/guides/tracking" }, { text: "Categories", link: "/docs/guides/categories" }, - { text: "Local manga", link: "/docs/guides/local-manga" }, + { + text: "Local series", + link: "/docs/guides/local-series/", + collapsed: true, + items: [ + { + text: "Advanced editing", + link: "/docs/guides/local-series/advanced", + }, + ], + }, { text: "Reader settings", link: "/docs/guides/reader-settings", diff --git a/website/src/docs/guides/local-series/advanced.md b/website/src/docs/guides/local-series/advanced.md new file mode 100644 index 00000000..c45a2428 --- /dev/null +++ b/website/src/docs/guides/local-series/advanced.md @@ -0,0 +1,48 @@ +--- +title: Advanced editing +description: Advanced local series metadata editing for enhanced library organization. +--- + +# Advanced editing +Advanced local series metadata editing for enhanced library organization. + +## Editing local series details + +It is possible to add details to local series. +Like series from other catalogs, you add information about the series such as the `author`, `artist`, `description`, and `genre` tags. + +To import details along with your local series, you have to create a JSON file. +It can be named anything but it must be placed within the **Series** folder. +A standard file name is `details.json`. +This file will contain the extended details about the series 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 series 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", + "artist": "Example Artist", + "description": "Example Description", + "genre": ["genre 1", "genre 2", "etc"], + "status": "0", + "_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 series. + +To do this, you only need to place the image file, that needs to be named `cover.jpg`, in the root of the series folder. +The app will then use your custom image in the local source listing. + + + diff --git a/website/src/docs/guides/local-manga.md b/website/src/docs/guides/local-series/index.md similarity index 70% rename from website/src/docs/guides/local-manga.md rename to website/src/docs/guides/local-series/index.md index 2f33a588..adcc808f 100644 --- a/website/src/docs/guides/local-manga.md +++ b/website/src/docs/guides/local-series/index.md @@ -1,25 +1,25 @@ --- -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. +title: Local series +description: If you like to download and organize your media, then you want to know how to manage your own series in Tachiyomi. --- -# Local manga +# Local series -If you like to download and organize your media, then you want to know how to manage your own manga in Tachiyomi. +If you like to download and organize your media, then you want to know how to manage your own series in Tachiyomi. ::: warning This page explores some advanced features. ::: -## Creating local manga +## Creating local series 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 series 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**. + > If adding series in folders it is recommended to add a file named `.nomedia` to the local folder so images do not show up in the gallery. +2. You should now be able to access the series in Browse → **Local source**. If you add more chapters then you'll have to manually refresh the chapter list (by pulling down the list). @@ -30,9 +30,9 @@ 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. +Tachiyomi requires a specific folder structure for local series to be correctly processed. +Local series will be read from the `Tachiyomi/local` folder. +Each series must have a `Series` 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: @@ -124,14 +124,14 @@ 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). +Tachiyomi will see four chapters in a single series. +The path to the folder with images must contain both the series 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. +You must place the archive inside the `Series` 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 {#example-archives} @@ -198,45 +198,6 @@ All images inside the archive regardless of folder structure will become pages f ::: -## Advanced - -### 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. - -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", - "artist": "Example Artist", - "description": "Example Description", - "genre": ["genre 1", "genre 2", "etc"], - "status": "0", - "_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. - -