feat: add support to info, and tag, and schema custom tamplates

demo/docusaurus.config.ts

@@ -297,7 +297,10 @@ const config: Config = {
               groupPathsBy: "tag",
               categoryLinkSource: "tag",
             },
-            template: "api.mustache", // Customize API MDX with mustache template
+            template: "templates/api.mustache", // Customize API MDX with mustache template
+            infoTemplate: "templates/info.mustache",
+            tagTemplate: "templates/tag.mustache",
+            schemaTemplate: "templates/schema.mustache",
             downloadUrl: "/petstore.yaml",
             hideSendButton: false,
             showSchemas: true,

demo/api.mustache → demo/templates/api.mustache

@@ -36,4 +36,16 @@ show_extensions: true
 {{/frontMatter.show_extensions}}
 ---
 
-{{{markdown}}}
+This is a Custom Api Page Generated by docusaurus-openapi-docs using `api.mustache` template
+
+<hr />
+<br />
+<br />
+
+{{{markdown}}}
+
+<br />
+<br />
+<hr />
+
+This is a Custom Api Page Generated by docusaurus-openapi-docs using `api.mustache` template

demo/templates/info.mustache

@@ -0,0 +1,22 @@
+---
+id: {{{id}}}
+title: "{{{title}}}"
+description: "{{{frontMatter.description}}}"
+sidebar_label: "{{{title}}}"
+hide_title: true
+custom_edit_url: null
+---
+
+This is a Custom Info Page Generated by docusaurus-openapi-docs using `info.mustache` template
+
+<hr />
+<br />
+<br />
+
+{{{markdown}}}
+
+<br />
+<br />
+<hr />
+
+This is a Custom Info Page Generated by docusaurus-openapi-docs using `info.mustache` template

demo/templates/schema.mustache

@@ -0,0 +1,27 @@
+---
+id: {{{id}}}
+title: "{{{title}}}"
+description: "{{{frontMatter.description}}}"
+sidebar_label: "{{{title}}}"
+hide_title: true
+{{#schema}}
+hide_table_of_contents: true
+{{/schema}}
+schema: true
+sample: {{{frontMatter.sample}}}
+custom_edit_url: null
+---
+
+This is a Custom Schema Page Generated by docusaurus-openapi-docs using `schema.mustache` template
+
+<hr />
+<br />
+<br />
+
+{{{markdown}}}
+
+<br />
+<br />
+<hr />
+
+This is a Custom Schema Page Generated by docusaurus-openapi-docs using `schema.mustache` template

demo/templates/tag.mustache

@@ -0,0 +1,20 @@
+---
+id: {{{id}}}
+title: "{{{frontMatter.description}}}"
+description: "{{{frontMatter.description}}}"
+custom_edit_url: null
+---
+
+This is a Custom Tag Page Generated by docusaurus-openapi-docs using `tag.mustache` template
+
+<hr />
+<br />
+<br />
+
+{{{markdown}}}
+
+<br />
+<br />
+<hr />
+
+This is a Custom Tag Page Generated by docusaurus-openapi-docs using `tag.mustache` template

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

@@ -117,6 +117,9 @@ export default function pluginOpenAPIDocs(
       specPath,
       outputDir,
       template,
+      infoTemplate,
+      tagTemplate,
+      schemaTemplate,
       markdownGenerators,
       downloadUrl,
       sidebarOptions,
@@ -236,7 +239,9 @@ show_extensions: true
 {{{markdown}}}
       `;
 
-      const infoMdTemplate = `---
+      const infoMdTemplate = infoTemplate
+        ? fs.readFileSync(infoTemplate).toString()
+        : `---
 id: {{{id}}}
 title: "{{{title}}}"
 description: "{{{frontMatter.description}}}"
@@ -255,7 +260,9 @@ import {useCurrentSidebarCategory} from '@docusaurus/theme-common';
 \`\`\`
       `;
 
-      const tagMdTemplate = `---
+      const tagMdTemplate = tagTemplate
+        ? fs.readFileSync(tagTemplate).toString()
+        : `---
 id: {{{id}}}
 title: "{{{frontMatter.description}}}"
 description: "{{{frontMatter.description}}}"
@@ -272,7 +279,9 @@ import {useCurrentSidebarCategory} from '@docusaurus/theme-common';
 \`\`\`
       `;
 
-      const schemaMdTemplate = `---
+      const schemaMdTemplate = schemaTemplate
+        ? fs.readFileSync(schemaTemplate).toString()
+        : `---
 id: {{{id}}}
 title: "{{{title}}}"
 description: "{{{frontMatter.description}}}"
@@ -371,21 +380,14 @@ custom_edit_url: null
           }
         }
 
-        // TODO: determine if we actually want/need this
         if (item.type === "info") {
           if (!fs.existsSync(`${outputDir}/${item.id}.info.mdx`)) {
             try {
-              sidebarOptions?.categoryLinkSource === "info" // Only use utils template if set to "info"
-                ? fs.writeFileSync(
-                    `${outputDir}/${item.id}.info.mdx`,
-                    utils,
-                    "utf8"
-                  )
-                : fs.writeFileSync(
-                    `${outputDir}/${item.id}.info.mdx`,
-                    view,
-                    "utf8"
-                  );
+              fs.writeFileSync(
+                `${outputDir}/${item.id}.info.mdx`,
+                utils,
+                "utf8"
+              );
               console.log(
                 chalk.green(
                   `Successfully created "${outputDir}/${item.id}.info.mdx"`

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

@@ -39,6 +39,9 @@ export const OptionsSchema = Joi.object({
         proxy: Joi.string(),
         outputDir: Joi.string().required(),
         template: Joi.string(),
+        infoTemplate: Joi.string(),
+        tagTemplate: Joi.string(),
+        schemaTemplate: Joi.string(),
         downloadUrl: Joi.string(),
         hideSendButton: Joi.boolean(),
         showExtensions: Joi.boolean(),

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

@@ -35,6 +35,9 @@ export interface APIOptions {
   specPath: string;
   outputDir: string;
   template?: string;
+  infoTemplate?: string;
+  tagTemplate?: string;
+  schemaTemplate?: string;
   downloadUrl?: string;
   hideSendButton?: boolean;
   showExtensions?: boolean;