dogsbay 0.2.0-beta.126 → 0.2.0-beta.128
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/dist/config/load.js
CHANGED
|
@@ -537,8 +537,8 @@ function validateContent(content, sourcePath) {
|
|
|
537
537
|
if (c.html !== undefined && c.html !== "keep" && c.html !== "sanitize") {
|
|
538
538
|
throw new Error(`content.html must be "keep" or "sanitize" in ${sourcePath}; got ${JSON.stringify(c.html)}`);
|
|
539
539
|
}
|
|
540
|
-
if (c.diagrams !== undefined && typeof c.diagrams !== "boolean") {
|
|
541
|
-
throw new Error(`content.diagrams must be
|
|
540
|
+
if (c.diagrams !== undefined && typeof c.diagrams !== "boolean" && c.diagrams !== "mermaid-cli" && c.diagrams !== "pele") {
|
|
541
|
+
throw new Error(`content.diagrams must be true, false, "mermaid-cli" or "pele" in ${sourcePath}; got ${JSON.stringify(c.diagrams)}`);
|
|
542
542
|
}
|
|
543
543
|
const linkIcons = validateLinkIcons(c.linkIcons, sourcePath);
|
|
544
544
|
// versions[] declarations + defaultVersion. When versions[] is
|
package/dist/config/schema.d.ts
CHANGED
|
@@ -532,14 +532,20 @@ export interface ContentConfig {
|
|
|
532
532
|
linkIcons?: boolean | LinkIconsInput;
|
|
533
533
|
/**
|
|
534
534
|
* Build-time SVG render for fenced diagrams (today: just Mermaid;
|
|
535
|
-
* future: PlantUML, D2, Graphviz under the same flag). When
|
|
536
|
-
* (the default), ` ```mermaid ` fences in dogsbay-md
|
|
537
|
-
* become `<Diagram>` components with pre-rendered SVG.
|
|
538
|
-
*
|
|
539
|
-
*
|
|
540
|
-
*
|
|
541
|
-
|
|
542
|
-
|
|
535
|
+
* future: PlantUML, D2, Graphviz under the same flag). When on
|
|
536
|
+
* (the default), ` ```mermaid ` fences in dogsbay-md and MkDocs
|
|
537
|
+
* sources become `<Diagram>` components with pre-rendered SVG.
|
|
538
|
+
*
|
|
539
|
+
* - `true` / `"mermaid-cli"` — `mmdc` (`@mermaid-js/mermaid-cli`,
|
|
540
|
+
* headless Chromium) on PATH or in the scaffold's node_modules;
|
|
541
|
+
* fail-open if missing (warns once, keeps the code block). Draws
|
|
542
|
+
* as Mermaid does. See plans/mermaid-dogsbay-md.md.
|
|
543
|
+
* - `"pele"` — Pele (npm `pele`), plain JavaScript, no browser;
|
|
544
|
+
* its own look, coloured by the site theme in light and dark.
|
|
545
|
+
* See plans/pele-diagrams.md.
|
|
546
|
+
* - `false` — keep every fence as a code block.
|
|
547
|
+
*/
|
|
548
|
+
diagrams?: boolean | "mermaid-cli" | "pele";
|
|
543
549
|
/**
|
|
544
550
|
* Declared versions for the version axis. When set, every
|
|
545
551
|
* source must carry a `version:` matching one of these ids
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "dogsbay",
|
|
3
|
-
"version": "0.2.0-beta.
|
|
3
|
+
"version": "0.2.0-beta.128",
|
|
4
4
|
"description": "CLI for Dogsbay — scaffold, build, and serve documentation sites with markdown / MkDocs / Obsidian / OpenAPI sources",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"bin": {
|
|
@@ -43,36 +43,36 @@
|
|
|
43
43
|
"typescript": "^5.9.3",
|
|
44
44
|
"valibot": "1.1.0",
|
|
45
45
|
"yaml": "^2.9.0",
|
|
46
|
-
"@dogsbay/adoc2md-modular": "0.2.0-beta.
|
|
47
|
-
"@dogsbay/autodoc-python": "0.2.0-beta.
|
|
48
|
-
"@dogsbay/commands": "0.2.0-beta.
|
|
49
|
-
"@dogsbay/format-asciidoc": "0.2.0-beta.
|
|
50
|
-
"@dogsbay/format-astro": "0.2.0-beta.
|
|
51
|
-
"@dogsbay/format-
|
|
52
|
-
"@dogsbay/format-
|
|
53
|
-
"@dogsbay/format-dogsbay-md": "0.2.0-beta.
|
|
54
|
-
"@dogsbay/format-fluidtopics-markdown": "0.2.0-beta.
|
|
55
|
-
"@dogsbay/format-fluidtopics-rest": "0.2.0-beta.
|
|
56
|
-
"@dogsbay/format-gatsby": "0.2.0-beta.
|
|
57
|
-
"@dogsbay/format-gitbook": "0.2.0-beta.
|
|
58
|
-
"@dogsbay/format-hugo": "0.2.0-beta.
|
|
59
|
-
"@dogsbay/format-mdx": "0.2.0-beta.
|
|
60
|
-
"@dogsbay/format-mkdocs": "0.2.0-beta.
|
|
61
|
-
"@dogsbay/format-myst": "0.2.0-beta.
|
|
62
|
-
"@dogsbay/format-obsidian": "0.2.0-beta.
|
|
63
|
-
"@dogsbay/format-openapi": "0.2.0-beta.
|
|
64
|
-
"@dogsbay/format-
|
|
65
|
-
"@dogsbay/format-
|
|
66
|
-
"@dogsbay/format-
|
|
67
|
-
"@dogsbay/format-
|
|
68
|
-
"@dogsbay/format-vitepress": "0.2.0-beta.
|
|
69
|
-
"@dogsbay/minja": "0.2.0-beta.
|
|
70
|
-
"@dogsbay/render": "0.2.0-beta.
|
|
71
|
-
"@dogsbay/render-html": "0.2.0-beta.
|
|
72
|
-
"@dogsbay/serialize-core": "0.2.0-beta.
|
|
73
|
-
"@dogsbay/site-check": "0.2.0-beta.
|
|
74
|
-
"@dogsbay/site-files": "0.2.0-beta.
|
|
75
|
-
"@dogsbay/types": "0.2.0-beta.
|
|
46
|
+
"@dogsbay/adoc2md-modular": "0.2.0-beta.128",
|
|
47
|
+
"@dogsbay/autodoc-python": "0.2.0-beta.128",
|
|
48
|
+
"@dogsbay/commands": "0.2.0-beta.128",
|
|
49
|
+
"@dogsbay/format-asciidoc": "0.2.0-beta.128",
|
|
50
|
+
"@dogsbay/format-astro": "0.2.0-beta.128",
|
|
51
|
+
"@dogsbay/format-docusaurus": "0.2.0-beta.128",
|
|
52
|
+
"@dogsbay/format-dita": "0.2.0-beta.128",
|
|
53
|
+
"@dogsbay/format-dogsbay-md": "0.2.0-beta.128",
|
|
54
|
+
"@dogsbay/format-fluidtopics-markdown": "0.2.0-beta.128",
|
|
55
|
+
"@dogsbay/format-fluidtopics-rest": "0.2.0-beta.128",
|
|
56
|
+
"@dogsbay/format-gatsby": "0.2.0-beta.128",
|
|
57
|
+
"@dogsbay/format-gitbook": "0.2.0-beta.128",
|
|
58
|
+
"@dogsbay/format-hugo": "0.2.0-beta.128",
|
|
59
|
+
"@dogsbay/format-mdx": "0.2.0-beta.128",
|
|
60
|
+
"@dogsbay/format-mkdocs": "0.2.0-beta.128",
|
|
61
|
+
"@dogsbay/format-myst": "0.2.0-beta.128",
|
|
62
|
+
"@dogsbay/format-obsidian": "0.2.0-beta.128",
|
|
63
|
+
"@dogsbay/format-openapi": "0.2.0-beta.128",
|
|
64
|
+
"@dogsbay/format-openknowledge": "0.2.0-beta.128",
|
|
65
|
+
"@dogsbay/format-rst": "0.2.0-beta.128",
|
|
66
|
+
"@dogsbay/format-topicmap": "0.2.0-beta.128",
|
|
67
|
+
"@dogsbay/format-starlight": "0.2.0-beta.128",
|
|
68
|
+
"@dogsbay/format-vitepress": "0.2.0-beta.128",
|
|
69
|
+
"@dogsbay/minja": "0.2.0-beta.128",
|
|
70
|
+
"@dogsbay/render": "0.2.0-beta.128",
|
|
71
|
+
"@dogsbay/render-html": "0.2.0-beta.128",
|
|
72
|
+
"@dogsbay/serialize-core": "0.2.0-beta.128",
|
|
73
|
+
"@dogsbay/site-check": "0.2.0-beta.128",
|
|
74
|
+
"@dogsbay/site-files": "0.2.0-beta.128",
|
|
75
|
+
"@dogsbay/types": "0.2.0-beta.128"
|
|
76
76
|
},
|
|
77
77
|
"devDependencies": {
|
|
78
78
|
"@mdx-js/mdx": "^3.1.1",
|
|
@@ -192,15 +192,15 @@ Code gets a copy button automatically. Pass `--highlight` to colour it.
|
|
|
192
192
|
|
|
193
193
|
## Nesting
|
|
194
194
|
|
|
195
|
-
|
|
195
|
+
Each `:::` closes the innermost block still open, so give every block its own closer:
|
|
196
196
|
|
|
197
197
|
```markdown
|
|
198
|
-
|
|
198
|
+
:::steps
|
|
199
199
|
1. **Check the lag**
|
|
200
200
|
:::warning
|
|
201
201
|
Above 30 s, page the on-call DBA.
|
|
202
202
|
:::
|
|
203
|
-
|
|
203
|
+
:::
|
|
204
204
|
```
|
|
205
205
|
|
|
206
206
|
## Not available in a single page
|
|
@@ -18,45 +18,43 @@ content
|
|
|
18
18
|
:::
|
|
19
19
|
```
|
|
20
20
|
|
|
21
|
-
|
|
22
|
-
(e.g., a directive nested inside another).
|
|
21
|
+
Nested directives can all use `:::` (see Nesting below).
|
|
23
22
|
|
|
24
|
-
### Nesting:
|
|
23
|
+
### Nesting: one closer per block
|
|
25
24
|
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
line of the same-or-shorter length, so an inner `:::` will
|
|
30
|
-
prematurely close a `:::` outer — leaving the rest of the
|
|
31
|
-
content stranded outside the directive.
|
|
32
|
-
|
|
33
|
-
❌ Wrong — the inner `:::` closes the outer `:::steps`:
|
|
25
|
+
Directives nest like XML elements: a closing `:::` ends the
|
|
26
|
+
innermost block still open, so plain `:::` works at every level.
|
|
27
|
+
Write one closer per opener, innermost first:
|
|
34
28
|
|
|
35
29
|
```markdown
|
|
36
30
|
:::steps
|
|
37
31
|
1. Install
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
32
|
+
|
|
33
|
+
:::warning
|
|
34
|
+
Don't skip this.
|
|
35
|
+
:::
|
|
36
|
+
|
|
41
37
|
2. Configure
|
|
42
38
|
:::
|
|
43
39
|
```
|
|
44
40
|
|
|
45
|
-
|
|
41
|
+
❌ Wrong — one `:::` closes ONE block, so this leaves `:::details`
|
|
42
|
+
open to the end of the page (`unclosed-container`):
|
|
46
43
|
|
|
47
44
|
```markdown
|
|
48
|
-
|
|
49
|
-
1. Install
|
|
45
|
+
:::details{summary="Setup"}
|
|
50
46
|
:::warning
|
|
51
47
|
Don't skip this.
|
|
52
48
|
:::
|
|
53
|
-
|
|
54
|
-
|
|
49
|
+
|
|
50
|
+
More text.
|
|
55
51
|
```
|
|
56
52
|
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
53
|
+
Scaled colons (`::::steps` around `:::warning`, closed with
|
|
54
|
+
`::::`) still read the same, and are what parsers before
|
|
55
|
+
beta.127 need. Scale anyway when the inner block is a name
|
|
56
|
+
Dogsbay does not know (`:::widget`): the nesting does not count
|
|
57
|
+
it.
|
|
60
58
|
|
|
61
59
|
## Callouts
|
|
62
60
|
|