sekkei-preview 0.1.0 → 0.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +75 -0
- package/package.json +11 -1
package/README.md
ADDED
|
@@ -0,0 +1,75 @@
|
|
|
1
|
+
# sekkei-preview
|
|
2
|
+
|
|
3
|
+
[](https://www.npmjs.com/package/sekkei-preview)
|
|
4
|
+
[](../../LICENSE)
|
|
5
|
+
[](https://nodejs.org/)
|
|
6
|
+
|
|
7
|
+
VitePress-based live preview + WYSIWYG editor for Sekkei specification documents.
|
|
8
|
+
|
|
9
|
+
## Features
|
|
10
|
+
|
|
11
|
+
- **VitePress SSG** — fast, Markdown-native documentation preview
|
|
12
|
+
- **Milkdown WYSIWYG** — rich-text editing for specification documents
|
|
13
|
+
- **Auto sidebar** — generates navigation from `sekkei.config.yaml`
|
|
14
|
+
- **Vue 3** — custom theme with Japanese document styling
|
|
15
|
+
- **Live reload** — instant preview updates on file changes
|
|
16
|
+
|
|
17
|
+
## Installation
|
|
18
|
+
|
|
19
|
+
```bash
|
|
20
|
+
npm install -g sekkei-preview
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
Or run directly:
|
|
24
|
+
|
|
25
|
+
```bash
|
|
26
|
+
npx sekkei-preview
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
## Quick Start
|
|
30
|
+
|
|
31
|
+
```bash
|
|
32
|
+
# 1. Generate documents with sekkei-mcp-server
|
|
33
|
+
/sekkei:functions-list @rfp.md
|
|
34
|
+
|
|
35
|
+
# 2. Start preview server
|
|
36
|
+
npx sekkei-preview
|
|
37
|
+
|
|
38
|
+
# 3. Open browser and edit in WYSIWYG mode
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
## Usage
|
|
42
|
+
|
|
43
|
+
```bash
|
|
44
|
+
sekkei-preview [options]
|
|
45
|
+
|
|
46
|
+
Options:
|
|
47
|
+
--docs-dir <path> Path to sekkei-docs directory (default: ./sekkei-docs)
|
|
48
|
+
--port <number> Preview server port (default: 5173)
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
The CLI reads `sekkei.config.yaml` from the project root to generate VitePress configuration, sidebar navigation, and document ordering.
|
|
52
|
+
|
|
53
|
+
## How It Works
|
|
54
|
+
|
|
55
|
+
1. Reads `sekkei.config.yaml` to discover generated documents
|
|
56
|
+
2. Generates VitePress config with sidebar from document chain
|
|
57
|
+
3. Serves the `sekkei-docs/` directory as a VitePress site
|
|
58
|
+
4. Milkdown editor provides WYSIWYG editing with live preview
|
|
59
|
+
|
|
60
|
+
## Ecosystem
|
|
61
|
+
|
|
62
|
+
| Package | Description |
|
|
63
|
+
|---------|-------------|
|
|
64
|
+
| [sekkei-mcp-server](../mcp-server/) | Core MCP server — generates the documents this package previews |
|
|
65
|
+
| [sekkei-skills](../skills/) | Claude Code slash commands — `/sekkei:preview` starts this server |
|
|
66
|
+
|
|
67
|
+
## 日本語
|
|
68
|
+
|
|
69
|
+
sekkei-previewは、Sekkeiで生成された日本語設計書をVitePressベースでプレビュー・編集するツールです。
|
|
70
|
+
|
|
71
|
+
Milkdown WYSIWYGエディタにより、ブラウザ上でリッチテキスト編集が可能です。`sekkei.config.yaml`からサイドバーナビゲーションを自動生成し、ドキュメントチェーンの順序で表示します。
|
|
72
|
+
|
|
73
|
+
## License
|
|
74
|
+
|
|
75
|
+
MIT
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "sekkei-preview",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.2.0",
|
|
4
4
|
"description": "VitePress-based preview + WYSIWYG editor for Sekkei specification documents",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"bin": {
|
|
@@ -40,5 +40,15 @@
|
|
|
40
40
|
"japanese",
|
|
41
41
|
"specification"
|
|
42
42
|
],
|
|
43
|
+
"repository": {
|
|
44
|
+
"type": "git",
|
|
45
|
+
"url": "https://github.com/bienhoang/sekkei-ai-agents.git",
|
|
46
|
+
"directory": "packages/preview"
|
|
47
|
+
},
|
|
48
|
+
"homepage": "https://github.com/bienhoang/sekkei-ai-agents/tree/main/packages/preview",
|
|
49
|
+
"bugs": "https://github.com/bienhoang/sekkei-ai-agents/issues",
|
|
50
|
+
"publishConfig": {
|
|
51
|
+
"access": "public"
|
|
52
|
+
},
|
|
43
53
|
"license": "MIT"
|
|
44
54
|
}
|