sudacode/SubMiner

Fork 0

mirror of https://github.com/ksyasuda/SubMiner.git synced 2026-07-28 04:49:49 -07:00

Files

T

History

sudacode d9155ceacb

docs: update requirements table and Windows install instructions

- Add TsukiHime and AniSkip to feature table; note xz dependency
- Clarify Anki+AnkiConnect is required to mine, not to run
- Rework Windows setup with winget/scoop commands and PATH steps
- Note ffmpeg has no path-override setting, unlike mpv
- Fix screenshot alt text and installation.md anchor link

2026-07-28 02:10:50 -07:00

.vitepress

docs: fix inaccuracies and add link/anchor validation tests

2026-07-28 00:56:38 -07:00

public

docs: fix inaccuracies and add link/anchor validation tests

2026-07-28 00:56:38 -07:00

.gitignore

move docs back repo

2026-03-10 19:47:16 -07:00

anilist-integration.md

docs(docs-site): correct and clarify docs against current code

2026-07-11 00:53:34 -07:00

aniskip-integration.md

docs(docs-site): correct and clarify docs against current code

2026-07-11 00:53:34 -07:00

anki-integration.md

docs(docs-site): correct and clarify docs against current code

2026-07-11 00:53:34 -07:00

architecture.md

docs(docs-site): correct and clarify docs against current code

2026-07-11 00:53:34 -07:00

bun.lock

fix(docs): proxy Plausible tracking script

2026-05-15 01:26:26 -07:00

changelog.md

Consolidate sync changelog fragments into one entry

2026-07-13 23:40:28 -07:00

character-dictionary.md

Anki maturity-based known-word highlighting (#172 )

2026-07-27 23:58:02 -07:00

configuration.md

docs: fix inaccuracies and add link/anchor validation tests

2026-07-28 00:56:38 -07:00

demos.md

docs: fix inaccuracies and add link/anchor validation tests

2026-07-28 00:56:38 -07:00

development.md

remove redundant isVerbNonIndependent and consolidate test lanes

2026-07-14 19:57:50 -07:00

docs-sync.test.ts

docs: fix inaccuracies and add link/anchor validation tests

2026-07-28 00:56:38 -07:00

immersion-tracking.md

docs(docs-site): correct and clarify docs against current code

2026-07-11 00:53:34 -07:00

index.assets.test.ts

[codex] add versioned Pages deployment (#73 )

2026-05-17 19:54:59 -07:00

index.md

docs: replace em-dashes with hyphens across docs-site

2026-06-02 23:36:44 -07:00

installation.md

docs: update requirements table and Windows install instructions

2026-07-28 02:10:50 -07:00

ipc-contracts.md

docs: replace em-dashes with hyphens across docs-site

2026-06-02 23:36:44 -07:00

jellyfin-integration.md

docs: replace em-dashes with hyphens across docs-site

2026-06-02 23:36:44 -07:00

jimaku-integration.md

docs: fix inaccuracies and add link/anchor validation tests

2026-07-28 00:56:38 -07:00

launcher-script.md

docs: fix inaccuracies and add link/anchor validation tests

2026-07-28 00:56:38 -07:00

links.test.ts

docs: fix inaccuracies and add link/anchor validation tests

2026-07-28 00:56:38 -07:00

mining-workflow.md

docs: fix inaccuracies and add link/anchor validation tests

2026-07-28 00:56:38 -07:00

mpv-plugin.md

docs(docs-site): correct and clarify docs against current code

2026-07-11 00:53:34 -07:00

package.json

docs: fix inaccuracies and add link/anchor validation tests

2026-07-28 00:56:38 -07:00

plausible.test.ts

fix(docs): correct versioned nav links and local dev version routing (#74 )

2026-05-18 01:07:17 -07:00

README.md

[codex] add versioned Pages deployment (#73 )

2026-05-17 19:54:59 -07:00

seo.test.ts

docs: fix inaccuracies and add link/anchor validation tests

2026-07-28 00:56:38 -07:00

shortcuts.md

refactor(tsukihime): swap Animetosho backend for TsukiHime API (#165 )

2026-07-13 22:03:35 -07:00

subtitle-annotations.md

Anki maturity-based known-word highlighting (#172 )

2026-07-27 23:58:02 -07:00

subtitle-sidebar.md

docs: replace em-dashes with hyphens across docs-site

2026-06-02 23:36:44 -07:00

troubleshooting.md

docs: fix inaccuracies and add link/anchor validation tests

2026-07-28 00:56:38 -07:00

tsukihime-integration.md

refactor(tsukihime): swap Animetosho backend for TsukiHime API (#165 )

2026-07-13 22:03:35 -07:00

usage.md

docs: fix inaccuracies and add link/anchor validation tests

2026-07-28 00:56:38 -07:00

websocket-texthooker-api.md

docs: fix inaccuracies and add link/anchor validation tests

2026-07-28 00:56:38 -07:00

youtube-integration.md

docs: fix inaccuracies and add link/anchor validation tests

2026-07-28 00:56:38 -07:00

README.md

SubMiner Docs

In-repo VitePress documentation source for SubMiner.

Internal architecture/workflow source of truth lives in docs/README.md at the repo root. Keep docs-site/ user-facing.

Local development

bun --cwd docs-site install
bun run docs:dev

Build and preview:

bun run docs:build
bun run docs:preview
bun run docs:test

Direct package commands still work from docs-site/ if you prefer:

cd docs-site
bun install
bun run docs:dev

Cloudflare Pages

Git repo: ksyasuda/SubMiner
Production branch: main
Automatic production and preview deployments: disabled
Custom domain: docs.subminer.moe attached to Production
Deployment path: GitHub Actions direct upload with Wrangler

The public docs root is stable-only:

/ serves the latest stable release docs.
/main/ serves development docs from main and is marked noindex,follow.
/v/<version>/ serves stable release archives.
Prerelease tags do not update the docs site.

Keep Cloudflare Git auto-deploy disabled. The production deploy is .github/workflows/docs-pages.yml, which uploads .tmp/docs-versioned-site with --branch main so tag-triggered runs update Production instead of creating preview deployments.