@rse/specbook 0.9.9 → 1.0.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 +26 -19
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -31,7 +31,7 @@ CLI with commands `specbook <xxx>`, and an MCP service with tools
|
|
|
31
31
|
- **Versatile Object to Markdown Mapping**:
|
|
32
32
|
Objects are authored as plain Markdown headings, property lists,
|
|
33
33
|
and description prose. The objects can be mapped to nested sections
|
|
34
|
-
("complex" format) or
|
|
34
|
+
("complex" format) or compact bullet point lists ("concise" and
|
|
35
35
|
"group" format).
|
|
36
36
|
|
|
37
37
|
- **Wiki-Style Object Linking**:
|
|
@@ -52,7 +52,7 @@ CLI with commands `specbook <xxx>`, and an MCP service with tools
|
|
|
52
52
|
schema, whose nodes and edges are automatically derived from the
|
|
53
53
|
object model and its references. The diagrams are rendered with the
|
|
54
54
|
sibling project [Gradia](https://github.com/rse/gradia), which is
|
|
55
|
-
specialized
|
|
55
|
+
specialized in rendering object models.
|
|
56
56
|
|
|
57
57
|
- **CLI, MCP, and API Interface**:
|
|
58
58
|
All commands are implemented once in the API class `SpecBook`, on
|
|
@@ -80,34 +80,26 @@ CLI with commands `specbook <xxx>`, and an MCP service with tools
|
|
|
80
80
|
It is intended as a polished, paginated offline document for handing
|
|
81
81
|
over to customers.
|
|
82
82
|
|
|
83
|
-
Overview
|
|
84
|
-
|
|
83
|
+
Overview
|
|
84
|
+
--------
|
|
85
85
|
|
|
86
86
|
[](etc/poster-1.pdf)
|
|
87
87
|
|
|
88
88
|
[](etc/poster-2.pdf)
|
|
89
89
|
|
|
90
|
-
|
|
91
|
-
|
|
90
|
+
Installation
|
|
91
|
+
------------
|
|
92
92
|
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
### HTML Rendering (Dark Theme)
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
### PDF Rendering
|
|
102
|
-
|
|
103
|
-
|
|
93
|
+
```bash
|
|
94
|
+
$ npm install -g @rse/specbook
|
|
95
|
+
```
|
|
104
96
|
|
|
105
97
|
Usage
|
|
106
98
|
-----
|
|
107
99
|
|
|
108
100
|
### CLI
|
|
109
101
|
|
|
110
|
-
```
|
|
102
|
+
```bash
|
|
111
103
|
$ specbook init [-v] [-c <yaml-file>] [-b <basedir>]
|
|
112
104
|
$ specbook lint [-v] [-c <yaml-file>] [-b <basedir>]
|
|
113
105
|
$ specbook export [-v] [-c <yaml-file>] [-b <basedir>] [-o [<format>:]<output-file>] [...]
|
|
@@ -118,7 +110,7 @@ $ specbook mcp [-v]
|
|
|
118
110
|
The YAML schema configuration `-c`/`--config` (default: the bundled
|
|
119
111
|
standard schema configuration `specbook-format.yaml`) determines the
|
|
120
112
|
specification: exactly the artifact files its `file` fields reference
|
|
121
|
-
are loaded and parsed
|
|
113
|
+
are loaded and parsed; all other Markdown files below the base
|
|
122
114
|
directory are ignored. A referenced
|
|
123
115
|
file which is absent is reported, unless all of its artifacts are
|
|
124
116
|
`optional`, and so is an artifact absent from its present file, unless
|
|
@@ -173,6 +165,21 @@ const result = await specbook.lint({
|
|
|
173
165
|
Run `specbook mcp` to serve the tools `specbook_init`, `specbook_lint`,
|
|
174
166
|
`specbook_export`, and `specbook_describe` over stdio.
|
|
175
167
|
|
|
168
|
+
Rendering Examples
|
|
169
|
+
------------------
|
|
170
|
+
|
|
171
|
+
### HTML Rendering (Light Theme)
|
|
172
|
+
|
|
173
|
+
|
|
174
|
+
|
|
175
|
+
### HTML Rendering (Dark Theme)
|
|
176
|
+
|
|
177
|
+
|
|
178
|
+
|
|
179
|
+
### PDF Rendering
|
|
180
|
+
|
|
181
|
+
|
|
182
|
+
|
|
176
183
|
License
|
|
177
184
|
-------
|
|
178
185
|
|