Skip to content

Commit 8f65ebc

Browse files
committed
Add admonition example to doc card spec
1 parent 9901775 commit 8f65ebc

File tree

3 files changed

+26
-0
lines changed

3 files changed

+26
-0
lines changed

demo/examples/tests/docCards.yaml

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,18 @@ paths:
1313
responses:
1414
"200":
1515
description: OK
16+
/docs-admon:
17+
get:
18+
summary: Doc card admonition operation
19+
description: >
20+
:::info
21+
Returns documentation with **markdown** and <b>HTML</b> in descriptions inside an admonition.
22+
:::
23+
tags:
24+
- docCards
25+
responses:
26+
"200":
27+
description: OK
1628

1729
tags:
1830
- name: docCards

packages/docusaurus-plugin-openapi-docs/src/openapi/__fixtures__/docCards/openapi.yaml

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,18 @@ paths:
1313
responses:
1414
"200":
1515
description: OK
16+
/docs-admon:
17+
get:
18+
summary: Doc card admonition operation
19+
description: >
20+
:::info
21+
Returns documentation with **markdown** and <b>HTML</b> in descriptions inside an admonition.
22+
:::
23+
tags:
24+
- docCards
25+
responses:
26+
"200":
27+
description: OK
1628

1729
tags:
1830
- name: docCards

packages/docusaurus-plugin-openapi-docs/src/openapi/openapi.test.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,8 @@ describe("openapi", () => {
4949
expect(tag?.description).toBe(
5050
"This tag shows **markdown** and <b>HTML</b> in the doc card."
5151
);
52+
const op = yaml?.data.paths?.["/docs-admon"]?.get;
53+
expect(op?.description).toContain(":::info");
5254
});
5355
});
5456
});

0 commit comments

Comments
 (0)