mirror of https://github.com/ksyasuda/SubMiner.git synced 2026-04-05 00:12:06 -07:00

Files

docs: expand launcher and Windows guidance across README and docs-site

- Add downloads/release/license/TypeScript badges to README, replace static badge set
- Add macOS launcher install instructions (wget/curl + make install-macos)
- Add Windows experimental warning and bun run subminer clarification
- Update launcher-script.md: rename "wrapper" to "launcher", add Windows tip
- Update usage.md: add Windows mpv shortcut row, clarify shebang behavior per platform
- Update installation.md: mkdir -p, improve Linux/macOS launcher sections

2026-04-04 14:37:58 -07:00

.vitepress

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

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

public

chore(config): update fresh-install defaults

2026-04-03 22:22:46 -07:00

.gitignore

move docs back repo

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

anilist-integration.md

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

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

anki-integration.md

feat: add app-owned YouTube subtitle flow with absPlayer-style parsing (#31 )

2026-03-24 00:01:24 -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

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

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

character-dictionary.md

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

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

configuration.md

chore(config): update fresh-install defaults

2026-04-03 22:22:46 -07:00

demos.md

move docs back repo

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

development.md

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

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

docs-sync.test.ts

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

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

immersion-tracking.md

chore(config): update fresh-install defaults

2026-04-03 22:22:46 -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: expand launcher and Windows guidance across README and docs-site

2026-04-04 14:37:58 -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

move docs back repo

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

jimaku-integration.md

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

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

jlpt-vocab-bundle.md

move docs back repo

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

launcher-script.md

docs: expand launcher and Windows guidance across README and docs-site

2026-04-04 14:37:58 -07:00

mining-workflow.md

chore(config): update fresh-install defaults

2026-04-03 22:22:46 -07:00

mpv-plugin.md

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

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

package.json

move docs back repo

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

plausible.test.ts

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

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

README.md

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

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

shortcuts.md

Add playlist browser overlay modal (#37 )

2026-03-31 12:28:29 -07:00

subtitle-annotations.md

feat: add app-owned YouTube subtitle flow with absPlayer-style parsing (#31 )

2026-03-24 00:01:24 -07:00

subtitle-sidebar.md

chore(config): update fresh-install defaults

2026-04-03 22:22:46 -07:00

troubleshooting.md

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

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

usage.md

docs: expand launcher and Windows guidance across README and docs-site

2026-04-04 14:37:58 -07:00

websocket-texthooker-api.md

chore(config): update fresh-install defaults

2026-04-03 22:22:46 -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.