Write and update the VitePress documentation website for stock indicators. Use when adding a new indicator page, updating an existing indicator page, or making structural changes to the docs site.
This skill covers writing and updating the VitePress documentation site located in the docs/ folder, with focus on indicator reference pages.
The site is built with VitePress and Vue 3.
| Path | Purpose |
|---|---|
docs/indicators/ | One .md file per indicator (the primary audience) |
docs/.vitepress/config.mts | Site config — nav, sidebar, metadata |
docs/.vitepress/components/ | Vue components used inside Markdown |
docs/.vitepress/public/assets/ | Static images (webp, optimized) |
docs/.vitepress/public/data/ | Chart JSON files (one per indicator key) |
docs/guide/getting-started.md | Get started: install + first call |
docs/guide/index.md | Guide overview + style comparison |
docs/guide/batch.md | Batch (Series) style guide |
docs/guide/buffer.md | Buffer list style guide |
docs/guide/stream.md | Stream hub style guide |
docs/guide/customization.md | Custom indicators guide |
docs/indicators.md | Indicators landing/index page |
docs/utilities/ | Utility API reference pages |
docs/performance.md | Performance benchmarks reference |
Excluded from build: AGENTS.md, PRINCIPLES.md, and README.md are excluded via srcExclude in config.mts and must not be linked from indicator pages.
# from /docs folder
pnpm install
pnpm run docs:dev
# site opens at http://localhost:5173/
Every indicator page at docs/indicators/{Indicator}.md follows this section order exactly. Never omit sections; use judgment about which optional elements apply.
---