@pantoken/typedoc-plugin-demo 0.1.1 → 0.1.2
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/index.d.mts +2 -2
- package/dist/index.mjs +3 -3
- package/package.json +1 -1
package/dist/index.d.mts
CHANGED
|
@@ -6,7 +6,7 @@ declare const DEMO_TAG = "@demo";
|
|
|
6
6
|
/** The fenced-code language the demo spec is emitted under — target it in your renderer. */
|
|
7
7
|
declare const DEMO_FENCE = "demo";
|
|
8
8
|
/**
|
|
9
|
-
* Wrap one demo spec in a fenced
|
|
9
|
+
* Wrap one demo spec in a fenced `demo` block.
|
|
10
10
|
*
|
|
11
11
|
* @param spec - A demo spec: a bare URL or a `<provider>:<ref>` pair.
|
|
12
12
|
* @returns The fenced code block as a string.
|
|
@@ -20,7 +20,7 @@ declare const DEMO_FENCE = "demo";
|
|
|
20
20
|
*/
|
|
21
21
|
declare function toDemoFence(spec: string): string;
|
|
22
22
|
/**
|
|
23
|
-
* Move every `@demo` block tag on a comment into
|
|
23
|
+
* Move every `@demo` block tag on a comment into `demo` fences appended to its summary, in order.
|
|
24
24
|
* Block-tag content gets re-fenced by the markdown theme, so the fence must live in the summary
|
|
25
25
|
* prose, which is emitted verbatim.
|
|
26
26
|
*
|
package/dist/index.mjs
CHANGED
|
@@ -9,7 +9,7 @@ import { Converter, RendererEvent } from "typedoc";
|
|
|
9
9
|
* a bare URL or a `<provider>:<ref>` pair (for example `stackblitz:abc123`, `codesandbox:xy12z`,
|
|
10
10
|
* `wp-playground:https://…/blueprint.json`, or `self:button`). This plugin registers nothing about
|
|
11
11
|
* providers itself — it stays deliberately dumb and reusable: it moves each `@demo` tag's spec into
|
|
12
|
-
* a fenced
|
|
12
|
+
* a fenced `demo` block appended to the symbol's summary, and your docs renderer decides how to
|
|
13
13
|
* turn a spec into an iframe. (See `@pantoken/demo` for a renderer that resolves the providers.)
|
|
14
14
|
*
|
|
15
15
|
* The fence rides through markdown untouched — including any translation pipeline that preserves
|
|
@@ -36,7 +36,7 @@ const DEMO_TAG = "@demo";
|
|
|
36
36
|
/** The fenced-code language the demo spec is emitted under — target it in your renderer. */
|
|
37
37
|
const DEMO_FENCE = "demo";
|
|
38
38
|
/**
|
|
39
|
-
* Wrap one demo spec in a fenced
|
|
39
|
+
* Wrap one demo spec in a fenced `demo` block.
|
|
40
40
|
*
|
|
41
41
|
* @param spec - A demo spec: a bare URL or a `<provider>:<ref>` pair.
|
|
42
42
|
* @returns The fenced code block as a string.
|
|
@@ -60,7 +60,7 @@ function* commentsOf(reflection) {
|
|
|
60
60
|
if (declaration.setSignature?.comment) yield declaration.setSignature.comment;
|
|
61
61
|
}
|
|
62
62
|
/**
|
|
63
|
-
* Move every `@demo` block tag on a comment into
|
|
63
|
+
* Move every `@demo` block tag on a comment into `demo` fences appended to its summary, in order.
|
|
64
64
|
* Block-tag content gets re-fenced by the markdown theme, so the fence must live in the summary
|
|
65
65
|
* prose, which is emitted verbatim.
|
|
66
66
|
*
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@pantoken/typedoc-plugin-demo",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.2",
|
|
4
4
|
"description": "TypeDoc plugin: turn a @demo <provider>:<ref> block tag into an embeddable demo fence your docs render as an iframe.",
|
|
5
5
|
"homepage": "https://pantoken.iywahl.com",
|
|
6
6
|
"bugs": "https://github.com/thedannywahl/pantoken/issues",
|