Skip to content

How to add a repository

This directory is a plain VitePress site. The repository list lives in a single TypeScript data file:

docs/.vitepress/repo-catalog.ts

Add or edit an entry

  1. Edit docs/.vitepress/repo-catalog.ts
  2. Add or update an object in the repos array:
{
  kind: "MIHON",
  name: "Example Repo",
  url: "https://example.com/index.min.json",
  note: "Optional note shown on the card",
  contentTypes: ["MANGA"],
  languages: ["English", "Japanese"],
}

kind

Must be one of the Kototoro unified source kinds:

KindUsed for
JARKototoro parser jar indexes
CLOUDSTREAMCloudStream provider repositories
MIHONMihon/Tachiyomi extension repositories
ANIYOMIAniyomi extension repositories
IREADERIReader extension repositories
LNREADERLNReader plugin indexes
LEGADOLegado book source lists
TVBOXTVBox source lists
TSUNDOKUTsundoku novel extension repositories

contentTypes

One or more of MANGA, NOVEL, VIDEO.

languages

One or more language labels used on the site, e.g. English, Chinese, Japanese, French, Turkish, Multilingual.

The site generates an Install / 安装 link automatically:

kototoro://add-repo?url=<encoded-url>&kind=<KIND>

Kototoro opens the add-repository dialog with the URL pre-filled.

Test locally

npm install
npm run docs:dev

Deploy

Push to the main branch. The GitHub Actions workflow in .github/workflows/deploy-pages.yml builds and publishes the site to GitHub Pages. Set the repository's GitHub Pages source to GitHub Actions.

Maintenance notes

Keep entries factual and up to date. If a repository stops working or no longer resolves, remove it or open a pull request with the fix.

Community-maintained repository directory for Kototoro