sudacode/SubMiner

Fork 0

mirror of https://github.com/ksyasuda/SubMiner.git synced 2026-05-13 08:12:54 -07:00

Files

T

History

sudacode f0324cd93a

docs: simplify Windows setup instructions and remove experimental warnin

- Remove "Windows support is experimental" warning across README and docs
- Replace `bun run subminer` references with SubMiner mpv shortcut as recommended Windows launch method
- Remove `subminer doctor` step from README quickstart
- Clarify launcher script is primarily for Linux/macOS

2026-05-13 00:30:55 -07:00

.vitepress

Add canonical URLs and sitemap dedup for docs homepage indexability

2026-05-10 22:19:21 -07:00

public

feat(config): update default startup and subtitle style options

2026-05-12 23:29:36 -07:00

.gitignore

move docs back repo

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

anilist-integration.md

docs: refresh README and docs site guidance

2026-04-06 01:19:15 -07:00

anki-integration.md

feat(tokenizer): use Yomitan word classes for subtitle POS filtering (#57 )

2026-05-12 12:08:09 -07:00

architecture.md

[codex] Make Windows mpv shortcut self-contained (#40 )

2026-04-03 21:35:18 -07:00

bun.lock

move docs back repo

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

changelog.md

docs: add v0.14.0 bundled plugin migration note to changelog

2026-05-13 00:11:18 -07:00

character-dictionary.md

Restore multi-copy digit capture and add AniList selection (#56 )

2026-04-25 21:44:55 -07:00

configuration.md

feat(config): update default startup and subtitle style options

2026-05-12 23:29:36 -07:00

demos.md

move docs back repo

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

development.md

feat: inject bundled mpv plugin for managed launches, remove legacy glob (#62 )

2026-05-12 23:11:19 -07:00

docs-sync.test.ts

docs: add mpv.launchMode to config docs, add changelog:docs generator, format

2026-04-07 01:06:43 -07:00

immersion-tracking.md

Persist stats exclusions in DB and fix word metrics filtering (#60 )

2026-05-03 20:06:13 -07:00

index.assets.test.ts

move docs back repo

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

index.md

Refactor startup, queries, and workflow into focused modules (#36 )

2026-03-29 16:16:29 -07:00

installation.md

docs: simplify Windows setup instructions and remove experimental warnin

2026-05-13 00:30:55 -07:00

ipc-contracts.md

docs: apply M PLUS 1 and Manrope font defaults for docs content

2026-03-25 23:52:29 -07:00

jellyfin-integration.md

[codex] Fix Jellyfin setup and discovery toggle (#59 )

2026-05-02 19:56:10 -07:00

jimaku-integration.md

docs: refresh README and docs site guidance

2026-04-06 01:19:15 -07:00

launcher-script.md

docs: simplify Windows setup instructions and remove experimental warnin

2026-05-13 00:30:55 -07:00

mining-workflow.md

feat(tokenizer): use Yomitan word classes for subtitle POS filtering (#57 )

2026-05-12 12:08:09 -07:00

mpv-plugin.md

feat: inject bundled mpv plugin for managed launches, remove legacy glob (#62 )

2026-05-12 23:11:19 -07:00

package.json

Add canonical URLs and sitemap dedup for docs homepage indexability

2026-05-10 22:19:21 -07:00

plausible.test.ts

Add canonical URLs and sitemap dedup for docs homepage indexability

2026-05-10 22:19:21 -07:00

README.md

feat(stats): add v1 immersion stats dashboard (#19 )

2026-03-20 02:43:28 -07:00

seo.test.ts

Add canonical URLs and sitemap dedup for docs homepage indexability

2026-05-10 22:19:21 -07:00

shortcuts.md

feat(config): show default keybindings in generated example config (#64 )

2026-05-12 23:11:51 -07:00

subtitle-annotations.md

docs: refresh README and docs site guidance

2026-04-06 01:19:15 -07:00

subtitle-sidebar.md

docs: refresh README and docs site guidance

2026-04-06 01:19:15 -07:00

troubleshooting.md

feat(tokenizer): use Yomitan word classes for subtitle POS filtering (#57 )

2026-05-12 12:08:09 -07:00

usage.md

docs: simplify Windows setup instructions and remove experimental warnin

2026-05-13 00:30:55 -07:00

websocket-texthooker-api.md

feat: open texthooker from cli and tray

2026-05-02 19:37:44 -07:00

youtube-integration.md

docs: apply M PLUS 1 and Manrope font defaults for docs content

2026-03-25 23:52:29 -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
Root directory: docs-site
Build command: bun run docs:build
Build output directory: .vitepress/dist
Build watch paths: docs-site/*

Cloudflare Pages watch paths use a single * wildcard for monorepo subdirectories. docs-site/* matches nested files under the docs site; docs-site/** can cause docs-only pushes to be skipped.