@docusaurus/plugin-content-docs 4.0.0-canary-6835 → 4.0.0-canary-6840
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/docs.js +2 -1
- package/lib/index.js +2 -1
- package/lib/options.js +2 -2
- package/lib/sidebars/index.js +2 -1
- package/lib/versions/loadVersion.js +1 -1
- package/package.json +12 -11
- package/src/docs.ts +2 -2
- package/src/index.ts +1 -1
- package/src/options.ts +1 -1
- package/src/sidebars/index.ts +3 -2
- package/src/versions/loadVersion.ts +1 -1
package/lib/docs.js
CHANGED
|
@@ -19,6 +19,7 @@ const path_1 = tslib_1.__importDefault(require("path"));
|
|
|
19
19
|
const fs_extra_1 = tslib_1.__importDefault(require("fs-extra"));
|
|
20
20
|
const lodash_1 = tslib_1.__importDefault(require("lodash"));
|
|
21
21
|
const utils_1 = require("@docusaurus/utils");
|
|
22
|
+
const glob_1 = require("@docusaurus/glob");
|
|
22
23
|
const frontMatter_1 = require("./frontMatter");
|
|
23
24
|
const slug_1 = tslib_1.__importDefault(require("./slug"));
|
|
24
25
|
const numberPrefix_1 = require("./numberPrefix");
|
|
@@ -30,7 +31,7 @@ async function readDocFile(versionMetadata, source) {
|
|
|
30
31
|
return { source, content, contentPath, filePath };
|
|
31
32
|
}
|
|
32
33
|
async function readVersionDocs(versionMetadata, options) {
|
|
33
|
-
const sources = await (0,
|
|
34
|
+
const sources = await (0, glob_1.glob)(options.include, {
|
|
34
35
|
cwd: versionMetadata.contentPath,
|
|
35
36
|
ignore: options.exclude,
|
|
36
37
|
});
|
package/lib/index.js
CHANGED
|
@@ -12,6 +12,7 @@ const tslib_1 = require("tslib");
|
|
|
12
12
|
const path_1 = tslib_1.__importDefault(require("path"));
|
|
13
13
|
const fs_extra_1 = tslib_1.__importDefault(require("fs-extra"));
|
|
14
14
|
const utils_1 = require("@docusaurus/utils");
|
|
15
|
+
const glob_1 = require("@docusaurus/glob");
|
|
15
16
|
const utils_validation_1 = require("@docusaurus/utils-validation");
|
|
16
17
|
const mdx_loader_1 = require("@docusaurus/mdx-loader");
|
|
17
18
|
const sidebars_1 = require("./sidebars");
|
|
@@ -83,7 +84,7 @@ async function pluginContentDocs(context, options) {
|
|
|
83
84
|
beforeDefaultRemarkPlugins,
|
|
84
85
|
staticDirs: siteConfig.staticDirectories.map((dir) => path_1.default.resolve(siteDir, dir)),
|
|
85
86
|
siteDir,
|
|
86
|
-
isMDXPartial: (0,
|
|
87
|
+
isMDXPartial: (0, glob_1.createAbsoluteFilePathMatcher)(options.exclude, contentDirs),
|
|
87
88
|
metadataPath: (mdxPath) => {
|
|
88
89
|
// Note that metadataPath must be the same/in-sync as
|
|
89
90
|
// the path from createData for each MDX.
|
package/lib/options.js
CHANGED
|
@@ -11,7 +11,7 @@ exports.validateOptions = validateOptions;
|
|
|
11
11
|
const tslib_1 = require("tslib");
|
|
12
12
|
const logger_1 = tslib_1.__importDefault(require("@docusaurus/logger"));
|
|
13
13
|
const utils_validation_1 = require("@docusaurus/utils-validation");
|
|
14
|
-
const
|
|
14
|
+
const glob_1 = require("@docusaurus/glob");
|
|
15
15
|
const generator_1 = require("./sidebars/generator");
|
|
16
16
|
const numberPrefix_1 = require("./numberPrefix");
|
|
17
17
|
exports.DEFAULT_OPTIONS = {
|
|
@@ -19,7 +19,7 @@ exports.DEFAULT_OPTIONS = {
|
|
|
19
19
|
routeBasePath: 'docs', // URL Route.
|
|
20
20
|
tagsBasePath: 'tags', // URL Tags Route.
|
|
21
21
|
include: ['**/*.{md,mdx}'], // Extensions to include.
|
|
22
|
-
exclude:
|
|
22
|
+
exclude: glob_1.GlobExcludeDefault,
|
|
23
23
|
sidebarItemsGenerator: generator_1.DefaultSidebarItemsGenerator,
|
|
24
24
|
numberPrefixParser: numberPrefix_1.DefaultNumberPrefixParser,
|
|
25
25
|
docsRootComponent: '@theme/DocsRoot',
|
package/lib/sidebars/index.js
CHANGED
|
@@ -16,6 +16,7 @@ const path_1 = tslib_1.__importDefault(require("path"));
|
|
|
16
16
|
const lodash_1 = tslib_1.__importDefault(require("lodash"));
|
|
17
17
|
const logger_1 = tslib_1.__importDefault(require("@docusaurus/logger"));
|
|
18
18
|
const utils_1 = require("@docusaurus/utils");
|
|
19
|
+
const glob_1 = require("@docusaurus/glob");
|
|
19
20
|
const Yaml = tslib_1.__importStar(require("js-yaml"));
|
|
20
21
|
const combine_promises_1 = tslib_1.__importDefault(require("combine-promises"));
|
|
21
22
|
const validation_1 = require("./validation");
|
|
@@ -38,7 +39,7 @@ function resolveSidebarPathOption(siteDir, sidebarPathOption) {
|
|
|
38
39
|
: sidebarPathOption;
|
|
39
40
|
}
|
|
40
41
|
async function readCategoriesMetadata(contentPath) {
|
|
41
|
-
const categoryFiles = await (0,
|
|
42
|
+
const categoryFiles = await (0, glob_1.glob)('**/_category_.{json,yml,yaml}', {
|
|
42
43
|
cwd: contentPath,
|
|
43
44
|
});
|
|
44
45
|
const categoryToFile = lodash_1.default.groupBy(categoryFiles, path_1.default.dirname);
|
|
@@ -19,7 +19,7 @@ const utils_2 = require("../sidebars/utils");
|
|
|
19
19
|
function ensureNoDuplicateDocId(docs) {
|
|
20
20
|
const duplicatesById = lodash_1.default.chain(docs)
|
|
21
21
|
.sort((d1, d2) => {
|
|
22
|
-
// Need to sort because
|
|
22
|
+
// Need to sort because glob order is non-deterministic
|
|
23
23
|
// TODO maybe we should create a deterministic glob utils?
|
|
24
24
|
// see https://github.com/sindresorhus/globby/issues/131
|
|
25
25
|
return d1.source.localeCompare(d2.source);
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@docusaurus/plugin-content-docs",
|
|
3
|
-
"version": "4.0.0-canary-
|
|
3
|
+
"version": "4.0.0-canary-6840",
|
|
4
4
|
"description": "Docs plugin for Docusaurus.",
|
|
5
5
|
"main": "lib/index.js",
|
|
6
6
|
"sideEffects": false,
|
|
@@ -35,15 +35,16 @@
|
|
|
35
35
|
},
|
|
36
36
|
"license": "MIT",
|
|
37
37
|
"dependencies": {
|
|
38
|
-
"@docusaurus/core": "4.0.0-canary-
|
|
39
|
-
"@docusaurus/
|
|
40
|
-
"@docusaurus/
|
|
41
|
-
"@docusaurus/
|
|
42
|
-
"@docusaurus/
|
|
43
|
-
"@docusaurus/
|
|
44
|
-
"@docusaurus/
|
|
45
|
-
"@docusaurus/utils
|
|
46
|
-
"@docusaurus/utils-
|
|
38
|
+
"@docusaurus/core": "4.0.0-canary-6840",
|
|
39
|
+
"@docusaurus/glob": "4.0.0-canary-6840",
|
|
40
|
+
"@docusaurus/logger": "4.0.0-canary-6840",
|
|
41
|
+
"@docusaurus/mdx-loader": "4.0.0-canary-6840",
|
|
42
|
+
"@docusaurus/module-type-aliases": "4.0.0-canary-6840",
|
|
43
|
+
"@docusaurus/theme-common": "4.0.0-canary-6840",
|
|
44
|
+
"@docusaurus/types": "4.0.0-canary-6840",
|
|
45
|
+
"@docusaurus/utils": "4.0.0-canary-6840",
|
|
46
|
+
"@docusaurus/utils-common": "4.0.0-canary-6840",
|
|
47
|
+
"@docusaurus/utils-validation": "4.0.0-canary-6840",
|
|
47
48
|
"@types/react-router-config": "^5.0.11",
|
|
48
49
|
"combine-promises": "^1.2.0",
|
|
49
50
|
"fs-extra": "^11.4.0",
|
|
@@ -66,5 +67,5 @@
|
|
|
66
67
|
"engines": {
|
|
67
68
|
"node": ">=24.21"
|
|
68
69
|
},
|
|
69
|
-
"gitHead": "
|
|
70
|
+
"gitHead": "b767143bc76b7747a9d1cc747dece7b06195a5c0"
|
|
70
71
|
}
|
package/src/docs.ts
CHANGED
|
@@ -16,12 +16,12 @@ import {
|
|
|
16
16
|
normalizeUrl,
|
|
17
17
|
parseMarkdownFile,
|
|
18
18
|
posixPath,
|
|
19
|
-
Globby,
|
|
20
19
|
isUnlisted,
|
|
21
20
|
isDraft,
|
|
22
21
|
readLastUpdateData,
|
|
23
22
|
normalizeTags,
|
|
24
23
|
} from '@docusaurus/utils';
|
|
24
|
+
import {glob} from '@docusaurus/glob';
|
|
25
25
|
import {validateDocFrontMatter} from './frontMatter';
|
|
26
26
|
import getSlug from './slug';
|
|
27
27
|
import {stripPathNumberPrefixes} from './numberPrefix';
|
|
@@ -66,7 +66,7 @@ export async function readVersionDocs(
|
|
|
66
66
|
'include' | 'exclude' | 'showLastUpdateAuthor' | 'showLastUpdateTime'
|
|
67
67
|
>,
|
|
68
68
|
): Promise<DocFile[]> {
|
|
69
|
-
const sources = await
|
|
69
|
+
const sources = await glob(options.include, {
|
|
70
70
|
cwd: versionMetadata.contentPath,
|
|
71
71
|
ignore: options.exclude,
|
|
72
72
|
});
|
package/src/index.ts
CHANGED
|
@@ -14,10 +14,10 @@ import {
|
|
|
14
14
|
getContentPathList,
|
|
15
15
|
posixPath,
|
|
16
16
|
addTrailingPathSeparator,
|
|
17
|
-
createAbsoluteFilePathMatcher,
|
|
18
17
|
resolveMarkdownLinkPathname,
|
|
19
18
|
DEFAULT_PLUGIN_ID,
|
|
20
19
|
} from '@docusaurus/utils';
|
|
20
|
+
import {createAbsoluteFilePathMatcher} from '@docusaurus/glob';
|
|
21
21
|
import {getTagsFilePathsToWatch} from '@docusaurus/utils-validation';
|
|
22
22
|
import {createMDXLoaderRule} from '@docusaurus/mdx-loader';
|
|
23
23
|
import {resolveSidebarPathOption} from './sidebars';
|
package/src/options.ts
CHANGED
|
@@ -15,7 +15,7 @@ import {
|
|
|
15
15
|
RouteBasePathSchema,
|
|
16
16
|
URISchema,
|
|
17
17
|
} from '@docusaurus/utils-validation';
|
|
18
|
-
import {GlobExcludeDefault} from '@docusaurus/
|
|
18
|
+
import {GlobExcludeDefault} from '@docusaurus/glob';
|
|
19
19
|
import {DefaultSidebarItemsGenerator} from './sidebars/generator';
|
|
20
20
|
import {
|
|
21
21
|
DefaultNumberPrefixParser,
|
package/src/sidebars/index.ts
CHANGED
|
@@ -9,7 +9,8 @@ import fs from 'fs-extra';
|
|
|
9
9
|
import path from 'path';
|
|
10
10
|
import _ from 'lodash';
|
|
11
11
|
import logger from '@docusaurus/logger';
|
|
12
|
-
import {loadFreshModule
|
|
12
|
+
import {loadFreshModule} from '@docusaurus/utils';
|
|
13
|
+
import {glob} from '@docusaurus/glob';
|
|
13
14
|
import * as Yaml from 'js-yaml';
|
|
14
15
|
import combinePromises from 'combine-promises';
|
|
15
16
|
import {validateSidebars, validateCategoryMetadataFile} from './validation';
|
|
@@ -41,7 +42,7 @@ export function resolveSidebarPathOption(
|
|
|
41
42
|
}
|
|
42
43
|
|
|
43
44
|
async function readCategoriesMetadata(contentPath: string) {
|
|
44
|
-
const categoryFiles = await
|
|
45
|
+
const categoryFiles = await glob('**/_category_.{json,yml,yaml}', {
|
|
45
46
|
cwd: contentPath,
|
|
46
47
|
});
|
|
47
48
|
const categoryToFile = _.groupBy(categoryFiles, path.dirname);
|
|
@@ -39,7 +39,7 @@ type LoadVersionParams = {
|
|
|
39
39
|
function ensureNoDuplicateDocId(docs: DocMetadataBase[]): void {
|
|
40
40
|
const duplicatesById = _.chain(docs)
|
|
41
41
|
.sort((d1, d2) => {
|
|
42
|
-
// Need to sort because
|
|
42
|
+
// Need to sort because glob order is non-deterministic
|
|
43
43
|
// TODO maybe we should create a deterministic glob utils?
|
|
44
44
|
// see https://github.com/sindresorhus/globby/issues/131
|
|
45
45
|
return d1.source.localeCompare(d2.source);
|