Skip to content

Commit 81fa7fc

Browse files
committed
group sidebar based on tag groups
1 parent 403990c commit 81fa7fc

File tree

3 files changed

+60
-3
lines changed

3 files changed

+60
-3
lines changed

apify-docs-theme/src/theme/custom.css

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -990,14 +990,19 @@ html[data-theme='dark'] .actionLink:hover::after {
990990
}
991991
}
992992

993-
aside li.section-header > div > .menu__link {
993+
aside li.section-header > div > .menu__link,
994+
aside li.section-header > ul > li > div > .menu__link {
994995
text-transform: uppercase;
995996
opacity: 0.8;
996997
font-size: 16px;
997998
font-weight: 700;
998999
margin: 0;
9991000
}
10001001

1002+
aside li.section-header > div > .menu__link {
1003+
font-size: 20px;
1004+
}
1005+
10011006
aside li.section-header.menu__list-item {
10021007
margin-top: 15px;
10031008
margin-bottom: 5px;
@@ -1011,6 +1016,11 @@ aside li.section-header > .menu__list {
10111016
padding-left: 0;
10121017
}
10131018

1019+
.theme-doc-sidebar-menu li.section-header > ul > li .menu__list-item-collapsible:hover,
1020+
.theme-doc-sidebar-menu li.section-header > ul > li .menu__list-item-collapsible--active {
1021+
background: inherit !important;
1022+
}
1023+
10141024
.beta-chip {
10151025
display: inline-block;
10161026
border: 1px solid #ccc;
Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
diff --git a/node_modules/docusaurus-plugin-openapi-docs/lib/sidebars/index.js b/node_modules/docusaurus-plugin-openapi-docs/lib/sidebars/index.js
2+
index 5802904..17409d5 100644
3+
--- a/node_modules/docusaurus-plugin-openapi-docs/lib/sidebars/index.js
4+
+++ b/node_modules/docusaurus-plugin-openapi-docs/lib/sidebars/index.js
5+
@@ -139,9 +139,18 @@ function groupByTags(items, sidebarOptions, options, tags, docPath) {
6+
}
7+
const taggedApiItems = apiItems.filter((item) => { var _a; return !!((_a = item.api.tags) === null || _a === void 0 ? void 0 : _a.includes(tag)); });
8+
const taggedSchemaItems = schemaItems.filter((item) => { var _a; return !!((_a = item.schema["x-tags"]) === null || _a === void 0 ? void 0 : _a.includes(tag)); });
9+
+ const altids = [];
10+
+
11+
+ if (tagObject?.['x-legacy-doc-urls']) {
12+
+ console.log(tagObject);
13+
+ altids.push(...tagObject['x-legacy-doc-urls']);
14+
+ }
15+
+
16+
return {
17+
type: "category",
18+
label: (_a = tagObject === null || tagObject === void 0 ? void 0 : tagObject["x-displayName"]) !== null && _a !== void 0 ? _a : tag,
19+
+ customProps: { altids },
20+
link: linkConfig,
21+
collapsible: sidebarCollapsible,
22+
collapsed: sidebarCollapsed,
23+
@@ -201,11 +210,12 @@ function generateSidebarSlice(sidebarOptions, options, api, tags, docPath, tagGr
24+
filteredTags.push(tag);
25+
}
26+
});
27+
+ const { sidebarCollapsed, sidebarCollapsible } = sidebarOptions;
28+
const groupCategory = {
29+
type: "category",
30+
label: tagGroup.name,
31+
- collapsible: true,
32+
- collapsed: true,
33+
+ collapsible: sidebarCollapsible,
34+
+ collapsed: sidebarCollapsed,
35+
items: groupByTags(api, sidebarOptions, options, [filteredTags], docPath),
36+
};
37+
if (options.showSchemas) {

sources/api/sidebars.js

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,22 @@
1+
// eslint-disable-next-line global-require
2+
const items = require('./sidebar.ts');
3+
4+
for (const item of items) {
5+
// this is wrongly rendered in each category (openapi group tag)
6+
if (item.items[0].id === 'apify-api') {
7+
item.items.shift();
8+
}
9+
}
10+
111
module.exports = {
212
api: [
313
{
414
type: 'category',
515
label: 'Apify API',
616
collapsible: false,
717
className: 'section-header',
8-
// eslint-disable-next-line global-require
9-
items: require('./sidebar.ts'),
18+
link: { type: 'doc', id: 'apify-api' },
19+
items,
1020
},
1121
],
1222
};

0 commit comments

Comments
 (0)