sekkei-preview
v0.3.0
Published
VitePress-based preview + WYSIWYG editor for Sekkei specification documents
Maintainers
Readme
sekkei-preview
VitePress-based live preview + WYSIWYG editor for Sekkei specification documents.
Features
- VitePress SSG — fast, Markdown-native documentation preview
- Milkdown WYSIWYG — rich-text editing for specification documents
- Auto sidebar — generates navigation from
sekkei.config.yaml - Vue 3 — custom theme with Japanese document styling
- Live reload — instant preview updates on file changes
Installation
npm install -g sekkei-previewOr run directly:
npx sekkei-previewQuick Start
# 1. Generate documents with sekkei-mcp-server
/sekkei:functions-list @rfp.md
# 2. Start preview server
npx sekkei-preview
# 3. Open browser and edit in WYSIWYG modeUsage
sekkei-preview [options]
Options:
--docs-dir <path> Path to sekkei-docs directory (default: ./sekkei-docs)
--port <number> Preview server port (default: 5173)The CLI reads sekkei.config.yaml from the project root to generate VitePress configuration, sidebar navigation, and document ordering.
How It Works
- Reads
sekkei.config.yamlto discover generated documents - Generates VitePress config with sidebar from document chain
- Serves the
sekkei-docs/directory as a VitePress site - Milkdown editor provides WYSIWYG editing with live preview
Ecosystem
| Package | Description |
|---------|-------------|
| sekkei-mcp-server | Core MCP server — generates the documents this package previews |
| sekkei-skills | Claude Code slash commands — /sekkei:preview starts this server |
日本語
sekkei-previewは、Sekkeiで生成された日本語設計書をVitePressベースでプレビュー・編集するツールです。
Milkdown WYSIWYGエディタにより、ブラウザ上でリッチテキスト編集が可能です。sekkei.config.yamlからサイドバーナビゲーションを自動生成し、ドキュメントチェーンの順序で表示します。
License
MIT
