Skip to content

Commit 529f99f

Browse files
committed
feat: add template defaults
1 parent bc6e70a commit 529f99f

File tree

1 file changed

+96
-0
lines changed
  • packages/docusaurus-plugin-openapi-docs/src/markdown

1 file changed

+96
-0
lines changed
Lines changed: 96 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,96 @@
1+
export const introMdTemplateDefault = `---
2+
id: {{{id}}}
3+
title: "{{{title}}}"
4+
description: "{{{frontMatter.description}}}"
5+
{{^api}}
6+
sidebar_label: Introduction
7+
{{/api}}
8+
{{#api}}
9+
sidebar_label: "{{{title}}}"
10+
{{/api}}
11+
{{^api}}
12+
sidebar_position: 0
13+
{{/api}}
14+
hide_title: true
15+
{{#api}}
16+
hide_table_of_contents: true
17+
{{/api}}
18+
{{#json}}
19+
api: {{{json}}}
20+
{{/json}}
21+
{{#api.method}}
22+
sidebar_class_name: "{{{api.method}}} api-method"
23+
{{/api.method}}
24+
{{#infoPath}}
25+
info_path: {{{infoPath}}}
26+
{{/infoPath}}
27+
custom_edit_url: null
28+
{{#frontMatter.proxy}}
29+
proxy: {{{frontMatter.proxy}}}
30+
{{/frontMatter.proxy}}
31+
{{#frontMatter.hide_send_button}}
32+
hide_send_button: true
33+
{{/frontMatter.hide_send_button}}
34+
{{#frontMatter.show_extensions}}
35+
show_extensions: true
36+
{{/frontMatter.show_extensions}}
37+
{{#frontMatter.mask_credentials_disabled}}
38+
mask_credentials: false
39+
{{/frontMatter.mask_credentials_disabled}}
40+
---
41+
42+
{{{markdown}}}
43+
`;
44+
45+
export const infoMdTemplateDefault = `---
46+
id: {{{id}}}
47+
title: "{{{title}}}"
48+
description: "{{{frontMatter.description}}}"
49+
sidebar_label: "{{{title}}}"
50+
hide_title: true
51+
custom_edit_url: null
52+
---
53+
54+
{{{markdown}}}
55+
56+
\`\`\`mdx-code-block
57+
import DocCardList from '@theme/DocCardList';
58+
import {useCurrentSidebarCategory} from '@docusaurus/theme-common';
59+
60+
<DocCardList items={useCurrentSidebarCategory().items}/>
61+
\`\`\`
62+
`;
63+
64+
export const tagMdTemplateDefault = `---
65+
id: {{{id}}}
66+
title: "{{{frontMatter.description}}}"
67+
description: "{{{frontMatter.description}}}"
68+
custom_edit_url: null
69+
---
70+
71+
{{{markdown}}}
72+
73+
\`\`\`mdx-code-block
74+
import DocCardList from '@theme/DocCardList';
75+
import {useCurrentSidebarCategory} from '@docusaurus/theme-common';
76+
77+
<DocCardList items={useCurrentSidebarCategory().items}/>
78+
\`\`\`
79+
`;
80+
81+
export const schemaMdTemplateDefault = `---;
82+
id: {{{id}}}
83+
title: "{{{title}}}"
84+
description: "{{{frontMatter.description}}}"
85+
sidebar_label: "{{{title}}}"
86+
hide_title: true
87+
{{#schema}}
88+
hide_table_of_contents: true
89+
{{/schema}}
90+
schema: true
91+
sample: {{{frontMatter.sample}}}
92+
custom_edit_url: null
93+
---
94+
95+
{{{markdown}}}
96+
`;

0 commit comments

Comments
 (0)