From b27f00bd978ff4fbe7e0dcba78f699c2bca8b3e3 Mon Sep 17 00:00:00 2001 From: HesterG Date: Mon, 22 May 2023 16:31:34 +0800 Subject: [PATCH] Sort usage directory by type first (#8) 1. Change name of "usage/actions", "usage/packages" to "usage/Actions" and "usage/Packages". 2. Sort usage directory by type first, so type "category" goes before "docs" Reference from [customize-the-sidebar-items-generator](https://docusaurus.io/docs/sidebar/autogenerated#customize-the-sidebar-items-generator) and [document](https://docusaurus.io/docs/cli#docusaurus-write-translations-sitedir) ![Screen Shot 2023-05-22 at 16.22.33](/attachments/5bbc88c9-9eca-4697-84b4-b8b3c2804eb0) Reviewed-on: https://gitea.com/gitea/gitea-docusaurus/pulls/8 Reviewed-by: Lunny Xiao Co-authored-by: HesterG Co-committed-by: HesterG --- docusaurus.config.js | 19 +++++++++++++++++++ .../current.json | 10 ++++++++++ 2 files changed, 29 insertions(+) create mode 100644 i18n/en/docusaurus-plugin-content-docs/current.json diff --git a/docusaurus.config.js b/docusaurus.config.js index a6e95d10..93ae90eb 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -4,6 +4,15 @@ const lightCodeTheme = require('prism-react-renderer/themes/github'); const darkCodeTheme = require('prism-react-renderer/themes/dracula'); +// order usage directory by type first +function sortItemsByCategory(items) { + // type with "category" (directory) first + const sortedItems = items.sort(function(a, b) { + return a.type.localeCompare(b.type); + }) + return sortedItems; +} + /** @type {import('@docusaurus/types').Config} */ const config = { title: 'Gitea Documentation', @@ -39,6 +48,16 @@ const config = { label: '1.19.3' } }, + async sidebarItemsGenerator({defaultSidebarItemsGenerator, ...args}) { + const {item} = args; + // Use the provided data to generate a custom sidebar slice + const sidebarItems = await defaultSidebarItemsGenerator(args); + if (item.dirName !== 'usage') { + return sidebarItems; + } else { + return sortItemsByCategory(sidebarItems); + } + }, }, blog: false, theme: { diff --git a/i18n/en/docusaurus-plugin-content-docs/current.json b/i18n/en/docusaurus-plugin-content-docs/current.json new file mode 100644 index 00000000..2dc75966 --- /dev/null +++ b/i18n/en/docusaurus-plugin-content-docs/current.json @@ -0,0 +1,10 @@ +{ + "sidebar.defaultSidebar.category.actions": { + "message": "Actions", + "description": "The label for category actions in sidebar defaultSidebar" + }, + "sidebar.defaultSidebar.category.packages": { + "message": "Packages", + "description": "The label for category packages in sidebar defaultSidebar" + } +}