mirror of
https://github.com/ksyasuda/SubMiner.git
synced 2026-03-20 12:11:28 -07:00
39 lines
887 B
Markdown
39 lines
887 B
Markdown
# 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
|
|
|
|
```bash
|
|
bun --cwd docs-site install
|
|
bun run docs:dev
|
|
```
|
|
|
|
Build and preview:
|
|
|
|
```bash
|
|
bun run docs:build
|
|
bun run docs:preview
|
|
bun run docs:test
|
|
```
|
|
|
|
Direct package commands still work from `docs-site/` if you prefer:
|
|
|
|
```bash
|
|
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.
|