@offorte/show-doc 0.0.6 → 0.0.7
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 +27 -7
- package/dist/THIRD_PARTY_LICENSES.md +820 -18
- package/dist/showdoc-mermaid.js +1106 -466
- package/dist/showdoc.js +1 -1
- package/package.json +2 -2
- package/skills/show-doc/SKILL.md +11 -3
package/README.md
CHANGED
|
@@ -152,12 +152,31 @@ showcase stays pinned to its matching package version.
|
|
|
152
152
|
|
|
153
153
|
## Diagrams
|
|
154
154
|
|
|
155
|
-
`shw-mermaid` draws flowcharts, state diagrams, and
|
|
156
|
-
a dotted canvas that the reader can drag and zoom. An expand button shows any
|
|
157
|
-
window, with a button for light and dark. Subgraphs become lanes. The classes
|
|
158
|
-
`changed`, and `removed` add a status pill. A frontmatter title appears in a chip, and text
|
|
159
|
-
`|` appears as grey code. Mermaid draws all other diagram types. These diagrams use React
|
|
160
|
-
the Mermaid bundle includes React and shows a small React Flow link in the corner.
|
|
155
|
+
`shw-mermaid` draws flowcharts, state diagrams, sequence diagrams, and block diagrams with cards,
|
|
156
|
+
routed lines, and a dotted canvas that the reader can drag and zoom. An expand button shows any
|
|
157
|
+
diagram over the full window, with a button for light and dark. Subgraphs become lanes. The classes
|
|
158
|
+
`new`, `changed`, and `removed` add a status pill. A frontmatter title appears in a chip, and text
|
|
159
|
+
after `|` appears as grey code. Mermaid draws all other diagram types. These diagrams use React
|
|
160
|
+
Flow, so the Mermaid bundle includes React and shows a small React Flow link in the corner.
|
|
161
|
+
|
|
162
|
+
A `block-beta` diagram places its cards in a grid. `columns` sets the grid width, `:2` makes a card
|
|
163
|
+
or group span two columns, `space` leaves a cell empty, and `block:id["Title"] … end` draws a titled
|
|
164
|
+
group with its own grid:
|
|
165
|
+
|
|
166
|
+
<!-- prettier-ignore -->
|
|
167
|
+
```html
|
|
168
|
+
<shw-mermaid label="Platform">
|
|
169
|
+
block-beta
|
|
170
|
+
columns 3
|
|
171
|
+
block:platform["Platform"]:2
|
|
172
|
+
columns 2
|
|
173
|
+
web["Web"] app["App"]
|
|
174
|
+
services["Domain services"]:2
|
|
175
|
+
end
|
|
176
|
+
eva[("EVA")]
|
|
177
|
+
services --> eva
|
|
178
|
+
</shw-mermaid>
|
|
179
|
+
```
|
|
161
180
|
|
|
162
181
|
Add the `page` attribute and leave out `shw-doc` to show one diagram in the full browser window:
|
|
163
182
|
|
|
@@ -203,7 +222,8 @@ Release Please reads Conventional Commit types on `main`. `fix:` and `opt:` prep
|
|
|
203
222
|
release.
|
|
204
223
|
|
|
205
224
|
Merging the Release Please pull request creates the GitHub release. The `Release package` workflow
|
|
206
|
-
then verifies and publishes the npm package. After publication succeeds, it
|
|
225
|
+
then verifies and publishes the npm package. After publication succeeds, it purges the `@latest`
|
|
226
|
+
files on jsDelivr and checks that jsDelivr serves the new version. It also calls the separate
|
|
207
227
|
`Deploy Pages` workflow with the release tag. `Deploy Pages` only deploys the example site. It can
|
|
208
228
|
also run manually.
|
|
209
229
|
|