diff --git a/docs/api/_category_.json b/docs/core/api/_category_.json similarity index 100% rename from docs/api/_category_.json rename to docs/core/api/_category_.json diff --git a/docs/api/app.md b/docs/core/api/app.md similarity index 100% rename from docs/api/app.md rename to docs/core/api/app.md diff --git a/docs/api/client.md b/docs/core/api/client.md similarity index 100% rename from docs/api/client.md rename to docs/core/api/client.md diff --git a/docs/api/constants.md b/docs/core/api/constants.md similarity index 100% rename from docs/api/constants.md rename to docs/core/api/constants.md diff --git a/docs/api/ctx.md b/docs/core/api/ctx.md similarity index 100% rename from docs/api/ctx.md rename to docs/core/api/ctx.md diff --git a/docs/api/fiber.md b/docs/core/api/fiber.md similarity index 100% rename from docs/api/fiber.md rename to docs/core/api/fiber.md diff --git a/docs/api/log.md b/docs/core/api/log.md similarity index 100% rename from docs/api/log.md rename to docs/core/api/log.md diff --git a/docs/api/middleware/_category_.json b/docs/core/api/middleware/_category_.json similarity index 100% rename from docs/api/middleware/_category_.json rename to docs/core/api/middleware/_category_.json diff --git a/docs/api/middleware/adaptor.md b/docs/core/api/middleware/adaptor.md similarity index 100% rename from docs/api/middleware/adaptor.md rename to docs/core/api/middleware/adaptor.md diff --git a/docs/api/middleware/basicauth.md b/docs/core/api/middleware/basicauth.md similarity index 100% rename from docs/api/middleware/basicauth.md rename to docs/core/api/middleware/basicauth.md diff --git a/docs/api/middleware/cache.md b/docs/core/api/middleware/cache.md similarity index 100% rename from docs/api/middleware/cache.md rename to docs/core/api/middleware/cache.md diff --git a/docs/api/middleware/compress.md b/docs/core/api/middleware/compress.md similarity index 100% rename from docs/api/middleware/compress.md rename to docs/core/api/middleware/compress.md diff --git a/docs/api/middleware/cors.md b/docs/core/api/middleware/cors.md similarity index 100% rename from docs/api/middleware/cors.md rename to docs/core/api/middleware/cors.md diff --git a/docs/api/middleware/csrf.md b/docs/core/api/middleware/csrf.md similarity index 100% rename from docs/api/middleware/csrf.md rename to docs/core/api/middleware/csrf.md diff --git a/docs/api/middleware/earlydata.md b/docs/core/api/middleware/earlydata.md similarity index 100% rename from docs/api/middleware/earlydata.md rename to docs/core/api/middleware/earlydata.md diff --git a/docs/api/middleware/encryptcookie.md b/docs/core/api/middleware/encryptcookie.md similarity index 100% rename from docs/api/middleware/encryptcookie.md rename to docs/core/api/middleware/encryptcookie.md diff --git a/docs/api/middleware/envvar.md b/docs/core/api/middleware/envvar.md similarity index 100% rename from docs/api/middleware/envvar.md rename to docs/core/api/middleware/envvar.md diff --git a/docs/api/middleware/etag.md b/docs/core/api/middleware/etag.md similarity index 100% rename from docs/api/middleware/etag.md rename to docs/core/api/middleware/etag.md diff --git a/docs/api/middleware/expvar.md b/docs/core/api/middleware/expvar.md similarity index 100% rename from docs/api/middleware/expvar.md rename to docs/core/api/middleware/expvar.md diff --git a/docs/api/middleware/favicon.md b/docs/core/api/middleware/favicon.md similarity index 100% rename from docs/api/middleware/favicon.md rename to docs/core/api/middleware/favicon.md diff --git a/docs/api/middleware/filesystem.md b/docs/core/api/middleware/filesystem.md similarity index 100% rename from docs/api/middleware/filesystem.md rename to docs/core/api/middleware/filesystem.md diff --git a/docs/api/middleware/helmet.md b/docs/core/api/middleware/helmet.md similarity index 100% rename from docs/api/middleware/helmet.md rename to docs/core/api/middleware/helmet.md diff --git a/docs/api/middleware/idempotency.md b/docs/core/api/middleware/idempotency.md similarity index 100% rename from docs/api/middleware/idempotency.md rename to docs/core/api/middleware/idempotency.md diff --git a/docs/api/middleware/keyauth.md b/docs/core/api/middleware/keyauth.md similarity index 100% rename from docs/api/middleware/keyauth.md rename to docs/core/api/middleware/keyauth.md diff --git a/docs/api/middleware/limiter.md b/docs/core/api/middleware/limiter.md similarity index 100% rename from docs/api/middleware/limiter.md rename to docs/core/api/middleware/limiter.md diff --git a/docs/api/middleware/logger.md b/docs/core/api/middleware/logger.md similarity index 100% rename from docs/api/middleware/logger.md rename to docs/core/api/middleware/logger.md diff --git a/docs/api/middleware/monitor.md b/docs/core/api/middleware/monitor.md similarity index 100% rename from docs/api/middleware/monitor.md rename to docs/core/api/middleware/monitor.md diff --git a/docs/api/middleware/pprof.md b/docs/core/api/middleware/pprof.md similarity index 100% rename from docs/api/middleware/pprof.md rename to docs/core/api/middleware/pprof.md diff --git a/docs/api/middleware/proxy.md b/docs/core/api/middleware/proxy.md similarity index 100% rename from docs/api/middleware/proxy.md rename to docs/core/api/middleware/proxy.md diff --git a/docs/api/middleware/recover.md b/docs/core/api/middleware/recover.md similarity index 100% rename from docs/api/middleware/recover.md rename to docs/core/api/middleware/recover.md diff --git a/docs/api/middleware/redirect.md b/docs/core/api/middleware/redirect.md similarity index 100% rename from docs/api/middleware/redirect.md rename to docs/core/api/middleware/redirect.md diff --git a/docs/api/middleware/requestid.md b/docs/core/api/middleware/requestid.md similarity index 100% rename from docs/api/middleware/requestid.md rename to docs/core/api/middleware/requestid.md diff --git a/docs/api/middleware/rewrite.md b/docs/core/api/middleware/rewrite.md similarity index 100% rename from docs/api/middleware/rewrite.md rename to docs/core/api/middleware/rewrite.md diff --git a/docs/api/middleware/session.md b/docs/core/api/middleware/session.md similarity index 100% rename from docs/api/middleware/session.md rename to docs/core/api/middleware/session.md diff --git a/docs/api/middleware/skip.md b/docs/core/api/middleware/skip.md similarity index 100% rename from docs/api/middleware/skip.md rename to docs/core/api/middleware/skip.md diff --git a/docs/api/middleware/timeout.md b/docs/core/api/middleware/timeout.md similarity index 100% rename from docs/api/middleware/timeout.md rename to docs/core/api/middleware/timeout.md diff --git a/docs/extra/_category_.json b/docs/core/extra/_category_.json similarity index 100% rename from docs/extra/_category_.json rename to docs/core/extra/_category_.json diff --git a/docs/extra/benchmarks.md b/docs/core/extra/benchmarks.md similarity index 100% rename from docs/extra/benchmarks.md rename to docs/core/extra/benchmarks.md diff --git a/docs/extra/faq.md b/docs/core/extra/faq.md similarity index 100% rename from docs/extra/faq.md rename to docs/core/extra/faq.md diff --git a/docs/guide/_category_.json b/docs/core/guide/_category_.json similarity index 100% rename from docs/guide/_category_.json rename to docs/core/guide/_category_.json diff --git a/docs/guide/error-handling.md b/docs/core/guide/error-handling.md similarity index 100% rename from docs/guide/error-handling.md rename to docs/core/guide/error-handling.md diff --git a/docs/guide/faster-fiber.md b/docs/core/guide/faster-fiber.md similarity index 100% rename from docs/guide/faster-fiber.md rename to docs/core/guide/faster-fiber.md diff --git a/docs/guide/grouping.md b/docs/core/guide/grouping.md similarity index 100% rename from docs/guide/grouping.md rename to docs/core/guide/grouping.md diff --git a/docs/guide/hooks.md b/docs/core/guide/hooks.md similarity index 100% rename from docs/guide/hooks.md rename to docs/core/guide/hooks.md diff --git a/docs/guide/routing.md b/docs/core/guide/routing.md similarity index 100% rename from docs/guide/routing.md rename to docs/core/guide/routing.md diff --git a/docs/guide/templates.md b/docs/core/guide/templates.md similarity index 100% rename from docs/guide/templates.md rename to docs/core/guide/templates.md diff --git a/docs/guide/validation.md b/docs/core/guide/validation.md similarity index 100% rename from docs/guide/validation.md rename to docs/core/guide/validation.md diff --git a/docs/intro.md b/docs/core/intro.md similarity index 100% rename from docs/intro.md rename to docs/core/intro.md diff --git a/docs/partials/routing/handler.md b/docs/core/partials/routing/handler.md similarity index 100% rename from docs/partials/routing/handler.md rename to docs/core/partials/routing/handler.md diff --git a/docusaurus.config.js b/docusaurus.config.js index dd105f52363..af63c209fc9 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -30,10 +30,18 @@ const config = { [ '@docusaurus/plugin-client-redirects', { - redirects: [ - {to: '/category/-middleware', from: '/-middleware'}, - {to: '/guide/routing', from: '/routing'}, - {to: '/api/ctx', from: '/ctx'}, + redirects: [{ + to: '/category/-middleware', + from: '/-middleware' + }, + { + to: '/guide/routing', + from: '/routing' + }, + { + to: '/api/ctx', + from: '/ctx' + }, ], createRedirects(existingPath) { if (existingPath.includes('/v1.x')) { @@ -54,8 +62,7 @@ const config = { 'standalone', 'queryString', ], - pwaHead: [ - { + pwaHead: [{ tagName: "link", rel: "icon", href: "/img/favicon.png" @@ -73,6 +80,21 @@ const config = { ], }, ], + [ + '@docusaurus/plugin-content-docs', + ({ + id: 'contrib', + path: 'docs/contrib', + routeBasePath: 'contrib', + editUrl: (params) => { + return 'https://github.com/gofiber/contrib/edit/main/' + params.docPath; + }, + editCurrentVersion: true, + sidebarPath: require.resolve('./sidebarsContrib.js'), + showLastUpdateAuthor: true, + showLastUpdateTime: true, + }), + ], ], presets: [ @@ -81,6 +103,7 @@ const config = { /** @type {import('@docusaurus/preset-classic').Options} */ ({ docs: { + path: 'docs/core', routeBasePath: '/', sidebarCollapsed: false, sidebarPath: require.resolve('./sidebars.js'), @@ -89,7 +112,7 @@ const config = { editUrl: (params) => { // console.log(params); if (params.version === 'current') { - return 'https://github.com/gofiber/fiber/edit/master/docs/' + params.docPath; + return 'https://github.com/gofiber/fiber/edit/master/docs/' + params.docPath; } return undefined; }, @@ -120,7 +143,8 @@ const config = { srcDark: 'img/logo-dark.svg' }, items: [{ - to: 'https://gofiber.io', + type: 'doc', + docId: 'welcome', label: '🏠 Home', position: 'left', }, @@ -129,6 +153,16 @@ const config = { label: '☕ Donate', position: 'left', }, + { + type: 'dropdown', + label: '🧩 Extra', + position: 'left', + items: [{ + type: 'docsVersion', + label: 'Contrib', + docsPluginId: 'contrib', + }], + }, { to: 'https://github.com/gofiber/recipes', label: '🍳 Examples', diff --git a/sidebarsContrib.js b/sidebarsContrib.js new file mode 100644 index 00000000000..5d6a1510fa2 --- /dev/null +++ b/sidebarsContrib.js @@ -0,0 +1,22 @@ +/** + * Creating a sidebar enables you to: + - create an ordered group of docs + - render a sidebar for each doc of that group + - provide next/previous navigation + + The sidebars can be generated from the filesystem, or explicitly defined here. + + Create as many sidebars as you want. + */ + +// @ts-check + +/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */ +const sidebars = { + tutorialSidebar: [{ + type: 'autogenerated', + dirName: '.' + }], +}; + +module.exports = sidebars;