From d705a4314fa7780127f3ff3f584101fd30d92588 Mon Sep 17 00:00:00 2001 From: Amol Date: Fri, 4 Jul 2025 13:24:20 +0530 Subject: [PATCH] Autogenerate API sidebar --- .gitignore | 7 ++++++- docs/docusaurus.config.js | 11 +++++++++++ docs/sidebars.js | 3 +-- 3 files changed, 18 insertions(+), 3 deletions(-) diff --git a/.gitignore b/.gitignore index b6dcebdf3..671d423cc 100644 --- a/.gitignore +++ b/.gitignore @@ -24,4 +24,9 @@ yarn-debug.log* yarn-error.log* apps/OpenSign/public/mfbuild/* microfrontends/SignDocuments/build/* -apps/OpenSignServer/files/files/* \ No newline at end of file +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/ diff --git a/docs/docusaurus.config.js b/docs/docusaurus.config.js index d2cc81475..ab81b00ff 100644 --- a/docs/docusaurus.config.js +++ b/docs/docusaurus.config.js @@ -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", + }, + }, } } }, diff --git a/docs/sidebars.js b/docs/sidebars.js index 928796da5..7cc6d1cb5 100644 --- a/docs/sidebars.js +++ b/docs/sidebars.js @@ -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