Autogenerate API sidebar

This commit is contained in:
Amol
2025-07-04 13:24:20 +05:30
parent 095040713e
commit d705a4314f
3 changed files with 18 additions and 3 deletions
+6 -1
View File
@@ -24,4 +24,9 @@ yarn-debug.log*
yarn-error.log*
apps/OpenSign/public/mfbuild/*
microfrontends/SignDocuments/build/*
apps/OpenSignServer/files/files/*
apps/OpenSignServer/files/files/*
# ignore generated API documentation
/docs/docs/API-docs/*
!/docs/docs/API-docs/opensign.yaml
!/docs/docs/API-docs/intro.md
/docs/docs/API-docs-1.1/
+11
View File
@@ -75,6 +75,17 @@ const config = {
sidebarOptions: {
groupPathsBy: "tag", // generate a sidebar.js slice that groups operations by tag
},
version: "1.0",
label: "v1.0",
baseUrl: "1.0",
versions: {
"1.1": {
specPath: "docs/API-docs/opensign.yaml",
outputDir: "docs/API-docs-1.1",
label: "v1.1",
baseUrl: "1.1",
},
},
}
}
},
+1 -2
View File
@@ -10,7 +10,6 @@
*/
// @ts-check
import apiSidebar from './docs/API-docs/sidebar.ts';
/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */
const sidebars = {
@@ -18,7 +17,7 @@ const sidebars = {
tutorialSidebar: [{type: 'autogenerated', dirName: 'help'}],
selfhostSidebar: [{type: 'autogenerated', dirName: 'self-host'}],
contributeSidebar: [{type: 'autogenerated', dirName: 'contribute'}],
apiSidebar: apiSidebar,
apiSidebar: [{type: 'autogenerated', dirName: 'API-docs'}],
// But you can create a sidebar manually