From c885a228bfa8bdc4cae387205ad1f73fa9699310 Mon Sep 17 00:00:00 2001 From: Devlin Pajaron Date: Thu, 22 Jan 2026 09:38:45 +0800 Subject: [PATCH] Update /api route to display all methods --- docs-md/api/index.md | 7 ------- scripts/md-generate.mjs | 27 ++++++++++++++++----------- sidebars.ts | 17 +++++++++++++++-- 3 files changed, 31 insertions(+), 20 deletions(-) delete mode 100644 docs-md/api/index.md diff --git a/docs-md/api/index.md b/docs-md/api/index.md deleted file mode 100644 index 2ca3445..0000000 --- a/docs-md/api/index.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -sidebar_position: 2 -id: api ---- -# API - -API reference for available methods. diff --git a/scripts/md-generate.mjs b/scripts/md-generate.mjs index 52ab3e1..547ec38 100644 --- a/scripts/md-generate.mjs +++ b/scripts/md-generate.mjs @@ -13,30 +13,35 @@ const SOURCE_DIR_URL = if (!fs.existsSync(OUTPUT_DIR)) { fs.mkdirSync(OUTPUT_DIR); } + +/** + * Get all method paths from src/ + * Create path as src/method/method.ts + */ +const getDirectories = async (source) => + (await readdir(source, { withFileTypes: true })) + .filter((dirent) => dirent.isDirectory()) + .map((dirent) => dirent.name); + +const methodDirectory = await getDirectories('src/'); +console.log('🍉debuu ~ methodDirectory:', methodDirectory); + // generate the _category_.json for docusaurus again // fs.writeFileSync( // `${OUTPUT_DIR}/_category_.json`, // JSON.stringify({ +// type: 'category', // label: 'API', // position: 2, // link: { // type: 'generated-index', // description: 'API reference for available methods.', +// slug: '/api', // }, +// items: ['api'], // }) // ); -/** - * Get all method paths from src/ - * Create path as src/method/method.ts - */ -const getDirectories = async (source) => - (await readdir(source, { withFileTypes: true })) - .filter((dirent) => dirent.isDirectory()) - .map((dirent) => dirent.name); - -const methodDirectory = await getDirectories('src/'); - /** * Loop each directory to generate markdown */ diff --git a/sidebars.ts b/sidebars.ts index 1bab49c..0ac57fa 100644 --- a/sidebars.ts +++ b/sidebars.ts @@ -12,8 +12,21 @@ import type { SidebarsConfig } from '@docusaurus/plugin-content-docs'; */ const sidebars: SidebarsConfig = { // By default, Docusaurus generates a sidebar from the docs folder structure - tutorialSidebar: [{ type: 'autogenerated', dirName: '.' }], - + tutorialSidebar: [ + 'getting-started', + { + type: 'category', + label: 'API', + items: [{ type: 'autogenerated', dirName: 'api' }], + link: { + type: 'generated-index', + slug: '/api', + title: 'API Reference', + description: 'Complete list of available API methods.', + }, + }, + 'changelog', + ], // But you can create a sidebar manually /* tutorialSidebar: [