@docusaurus/plugin-content-docs 0.0.0-4759 → 0.0.0-4762
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/lib/sidebars/utils.js +10 -4
- package/lib/types.d.ts +3 -4
- package/package.json +9 -9
- package/src/sidebars/utils.ts +11 -11
- package/src/types.ts +6 -5
package/lib/sidebars/utils.js
CHANGED
|
@@ -135,8 +135,11 @@ function createSidebarsUtils(sidebars) {
|
|
|
135
135
|
if (currentItemIndex === -1) {
|
|
136
136
|
return { sidebarName, next: undefined, previous: undefined };
|
|
137
137
|
}
|
|
138
|
-
|
|
139
|
-
|
|
138
|
+
return {
|
|
139
|
+
sidebarName,
|
|
140
|
+
previous: navigationItems[currentItemIndex - 1],
|
|
141
|
+
next: navigationItems[currentItemIndex + 1],
|
|
142
|
+
};
|
|
140
143
|
}
|
|
141
144
|
function getCategoryGeneratedIndexList() {
|
|
142
145
|
return Object.values(sidebarNameToNavigationItems)
|
|
@@ -161,8 +164,11 @@ function createSidebarsUtils(sidebars) {
|
|
|
161
164
|
const sidebarName = Object.entries(sidebarNameToNavigationItems).find(([, navigationItems]) => navigationItems.find(isCurrentCategoryGeneratedIndexItem))[0];
|
|
162
165
|
const navigationItems = sidebarNameToNavigationItems[sidebarName];
|
|
163
166
|
const currentItemIndex = navigationItems.findIndex(isCurrentCategoryGeneratedIndexItem);
|
|
164
|
-
|
|
165
|
-
|
|
167
|
+
return {
|
|
168
|
+
sidebarName,
|
|
169
|
+
previous: navigationItems[currentItemIndex - 1],
|
|
170
|
+
next: navigationItems[currentItemIndex + 1],
|
|
171
|
+
};
|
|
166
172
|
}
|
|
167
173
|
function checkSidebarsDocIds(validDocIds, sidebarFilePath) {
|
|
168
174
|
const allSidebarDocIds = Object.values(sidebarNameToDocIds).flat();
|
package/lib/types.d.ts
CHANGED
|
@@ -5,8 +5,7 @@
|
|
|
5
5
|
* LICENSE file in the root directory of this source tree.
|
|
6
6
|
*/
|
|
7
7
|
import type { Sidebars } from './sidebars/types';
|
|
8
|
-
import type { Tag, FrontMatterTag } from '@docusaurus/utils';
|
|
9
|
-
import type { BrokenMarkdownLink as IBrokenMarkdownLink, ContentPaths } from '@docusaurus/utils/lib/markdownLinks';
|
|
8
|
+
import type { Tag, FrontMatterTag, BrokenMarkdownLink, ContentPaths } from '@docusaurus/utils';
|
|
10
9
|
import type { VersionBanner } from '@docusaurus/plugin-content-docs';
|
|
11
10
|
export declare type DocFile = {
|
|
12
11
|
contentPath: string;
|
|
@@ -113,10 +112,10 @@ export declare type LoadedVersion = VersionMetadata & {
|
|
|
113
112
|
export declare type LoadedContent = {
|
|
114
113
|
loadedVersions: LoadedVersion[];
|
|
115
114
|
};
|
|
116
|
-
export declare type
|
|
115
|
+
export declare type DocBrokenMarkdownLink = BrokenMarkdownLink<VersionMetadata>;
|
|
117
116
|
export declare type DocsMarkdownOption = {
|
|
118
117
|
versionsMetadata: VersionMetadata[];
|
|
119
118
|
siteDir: string;
|
|
120
119
|
sourceToPermalink: SourceToPermalink;
|
|
121
|
-
onBrokenMarkdownLink: (brokenMarkdownLink:
|
|
120
|
+
onBrokenMarkdownLink: (brokenMarkdownLink: DocBrokenMarkdownLink) => void;
|
|
122
121
|
};
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@docusaurus/plugin-content-docs",
|
|
3
|
-
"version": "0.0.0-
|
|
3
|
+
"version": "0.0.0-4762",
|
|
4
4
|
"description": "Docs plugin for Docusaurus.",
|
|
5
5
|
"main": "lib/index.js",
|
|
6
6
|
"exports": {
|
|
@@ -23,11 +23,11 @@
|
|
|
23
23
|
},
|
|
24
24
|
"license": "MIT",
|
|
25
25
|
"dependencies": {
|
|
26
|
-
"@docusaurus/core": "0.0.0-
|
|
27
|
-
"@docusaurus/logger": "0.0.0-
|
|
28
|
-
"@docusaurus/mdx-loader": "0.0.0-
|
|
29
|
-
"@docusaurus/utils": "0.0.0-
|
|
30
|
-
"@docusaurus/utils-validation": "0.0.0-
|
|
26
|
+
"@docusaurus/core": "0.0.0-4762",
|
|
27
|
+
"@docusaurus/logger": "0.0.0-4762",
|
|
28
|
+
"@docusaurus/mdx-loader": "0.0.0-4762",
|
|
29
|
+
"@docusaurus/utils": "0.0.0-4762",
|
|
30
|
+
"@docusaurus/utils-validation": "0.0.0-4762",
|
|
31
31
|
"combine-promises": "^1.1.0",
|
|
32
32
|
"fs-extra": "^10.0.1",
|
|
33
33
|
"import-fresh": "^3.3.0",
|
|
@@ -39,8 +39,8 @@
|
|
|
39
39
|
"webpack": "^5.70.0"
|
|
40
40
|
},
|
|
41
41
|
"devDependencies": {
|
|
42
|
-
"@docusaurus/module-type-aliases": "0.0.0-
|
|
43
|
-
"@docusaurus/types": "0.0.0-
|
|
42
|
+
"@docusaurus/module-type-aliases": "0.0.0-4762",
|
|
43
|
+
"@docusaurus/types": "0.0.0-4762",
|
|
44
44
|
"@types/js-yaml": "^4.0.5",
|
|
45
45
|
"@types/picomatch": "^2.3.0",
|
|
46
46
|
"commander": "^5.1.0",
|
|
@@ -56,5 +56,5 @@
|
|
|
56
56
|
"engines": {
|
|
57
57
|
"node": ">=14"
|
|
58
58
|
},
|
|
59
|
-
"gitHead": "
|
|
59
|
+
"gitHead": "cff0f3b00d451a251a7b0d0e0dbe02d793e29e9f"
|
|
60
60
|
}
|
package/src/sidebars/utils.ts
CHANGED
|
@@ -20,7 +20,7 @@ import type {
|
|
|
20
20
|
} from './types';
|
|
21
21
|
|
|
22
22
|
import _ from 'lodash';
|
|
23
|
-
import {
|
|
23
|
+
import {toMessageRelativeFilePath} from '@docusaurus/utils';
|
|
24
24
|
import type {DocMetadataBase, DocNavLink} from '../types';
|
|
25
25
|
|
|
26
26
|
export function isCategoriesShorthand(
|
|
@@ -225,11 +225,11 @@ export function createSidebarsUtils(sidebars: Sidebars): SidebarsUtils {
|
|
|
225
225
|
return {sidebarName, next: undefined, previous: undefined};
|
|
226
226
|
}
|
|
227
227
|
|
|
228
|
-
|
|
229
|
-
|
|
230
|
-
currentItemIndex,
|
|
231
|
-
|
|
232
|
-
|
|
228
|
+
return {
|
|
229
|
+
sidebarName,
|
|
230
|
+
previous: navigationItems[currentItemIndex - 1],
|
|
231
|
+
next: navigationItems[currentItemIndex + 1],
|
|
232
|
+
};
|
|
233
233
|
}
|
|
234
234
|
|
|
235
235
|
function getCategoryGeneratedIndexList(): SidebarItemCategoryWithGeneratedIndex[] {
|
|
@@ -268,11 +268,11 @@ export function createSidebarsUtils(sidebars: Sidebars): SidebarsUtils {
|
|
|
268
268
|
const currentItemIndex = navigationItems.findIndex(
|
|
269
269
|
isCurrentCategoryGeneratedIndexItem,
|
|
270
270
|
);
|
|
271
|
-
|
|
272
|
-
|
|
273
|
-
currentItemIndex,
|
|
274
|
-
|
|
275
|
-
|
|
271
|
+
return {
|
|
272
|
+
sidebarName,
|
|
273
|
+
previous: navigationItems[currentItemIndex - 1],
|
|
274
|
+
next: navigationItems[currentItemIndex + 1],
|
|
275
|
+
};
|
|
276
276
|
}
|
|
277
277
|
|
|
278
278
|
function checkSidebarsDocIds(validDocIds: string[], sidebarFilePath: string) {
|
package/src/types.ts
CHANGED
|
@@ -8,11 +8,12 @@
|
|
|
8
8
|
/// <reference types="@docusaurus/module-type-aliases" />
|
|
9
9
|
|
|
10
10
|
import type {Sidebars} from './sidebars/types';
|
|
11
|
-
import type {Tag, FrontMatterTag} from '@docusaurus/utils';
|
|
12
11
|
import type {
|
|
13
|
-
|
|
12
|
+
Tag,
|
|
13
|
+
FrontMatterTag,
|
|
14
|
+
BrokenMarkdownLink,
|
|
14
15
|
ContentPaths,
|
|
15
|
-
} from '@docusaurus/utils
|
|
16
|
+
} from '@docusaurus/utils';
|
|
16
17
|
import type {VersionBanner} from '@docusaurus/plugin-content-docs';
|
|
17
18
|
|
|
18
19
|
export type DocFile = {
|
|
@@ -133,11 +134,11 @@ export type LoadedContent = {
|
|
|
133
134
|
loadedVersions: LoadedVersion[];
|
|
134
135
|
};
|
|
135
136
|
|
|
136
|
-
export type
|
|
137
|
+
export type DocBrokenMarkdownLink = BrokenMarkdownLink<VersionMetadata>;
|
|
137
138
|
|
|
138
139
|
export type DocsMarkdownOption = {
|
|
139
140
|
versionsMetadata: VersionMetadata[];
|
|
140
141
|
siteDir: string;
|
|
141
142
|
sourceToPermalink: SourceToPermalink;
|
|
142
|
-
onBrokenMarkdownLink: (brokenMarkdownLink:
|
|
143
|
+
onBrokenMarkdownLink: (brokenMarkdownLink: DocBrokenMarkdownLink) => void;
|
|
143
144
|
};
|