@redpanda-data/docs-extensions-and-macros 5.2.5 → 5.3.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/bin/doc-tools.js +159 -0
- package/package.json +1 -1
- package/tools/property-extractor/property_extractor.py +18 -1
- package/tools/property-extractor/transformers.py +29 -13
- package/tools/rpk-docs/generate-plugin-stubs.js +291 -0
- package/tools/rpk-docs/generate-rpk-docs.js +440 -25
- package/tools/rpk-docs/helpers/index.js +13 -3
- package/tools/rpk-docs/report-delta.js +314 -32
- package/tools/rpk-docs/rpk-docs-handler.js +1230 -102
- package/tools/rpk-docs/templates/command.hbs +5 -0
- package/tools/rpk-docs/templates/content-item.hbs +2 -2
|
@@ -24,6 +24,11 @@ ifndef::env-cloud[]
|
|
|
24
24
|
{{/each}}
|
|
25
25
|
|
|
26
26
|
// tag::single-source[]
|
|
27
|
+
:description: {{{wrapDescriptionPassthrough shortDesc}}}
|
|
28
|
+
{{!-- The description attribute is repeated inside the tagged region so
|
|
29
|
+
single-sourcing consumers (stub pages that include this tag) inherit
|
|
30
|
+
the meta description. page-aliases and page-platforms deliberately stay
|
|
31
|
+
outside the tag: consumers must not inherit alias registrations. --}}
|
|
27
32
|
{{!-- Deprecation notice --}}
|
|
28
33
|
{{#if deprecated}}
|
|
29
34
|
[CAUTION]
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
{{~#if (eq type "example")~}}
|
|
3
3
|
{{!-- Single structured example --}}
|
|
4
4
|
{{#if description}}
|
|
5
|
-
{{{description}}}
|
|
5
|
+
{{{ensurePeriod description}}}
|
|
6
6
|
|
|
7
7
|
{{/if}}
|
|
8
8
|
[,{{#if language}}{{language}}{{else}}bash{{/if}}{{#if attributes}}{{#each attributes}}{{#if @first}},{{/if}}{{@key}}="{{this}}"{{/each}}{{/if}}]
|
|
@@ -27,7 +27,7 @@ This section provides examples of how to use `{{commandPath}}`.
|
|
|
27
27
|
|
|
28
28
|
{{#each items}}
|
|
29
29
|
{{#if description}}
|
|
30
|
-
{{{description}}}
|
|
30
|
+
{{{ensurePeriod description}}}
|
|
31
31
|
|
|
32
32
|
{{/if}}
|
|
33
33
|
[,{{#if language}}{{language}}{{else}}bash{{/if}}{{#if attributes}}{{#each attributes}}{{#if @first}},{{/if}}{{@key}}="{{this}}"{{/each}}{{/if}}]
|