@docusaurus/plugin-content-docs 0.0.0-5008 → 0.0.0-5012

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.
@@ -4,8 +4,8 @@
4
4
  * This source code is licensed under the MIT license found in the
5
5
  * LICENSE file in the root directory of this source tree.
6
6
  */
7
- import type { CategoryGeneratedIndexMetadata, DocMetadataBase } from '@docusaurus/plugin-content-docs';
8
7
  import { type SidebarsUtils } from './sidebars/utils';
8
+ import type { CategoryGeneratedIndexMetadata, DocMetadataBase } from '@docusaurus/plugin-content-docs';
9
9
  export declare function getCategoryGeneratedIndexMetadataList({ docs, sidebarsUtils, }: {
10
10
  sidebarsUtils: SidebarsUtils;
11
11
  docs: DocMetadataBase[];
package/lib/cli.js CHANGED
@@ -8,14 +8,14 @@
8
8
  Object.defineProperty(exports, "__esModule", { value: true });
9
9
  exports.cliDocsVersionCommand = void 0;
10
10
  const tslib_1 = require("tslib");
11
- const files_1 = require("./versions/files");
12
- const validation_1 = require("./versions/validation");
13
11
  const fs_extra_1 = tslib_1.__importDefault(require("fs-extra"));
14
12
  const path_1 = tslib_1.__importDefault(require("path"));
13
+ const logger_1 = tslib_1.__importDefault(require("@docusaurus/logger"));
14
+ const utils_1 = require("@docusaurus/utils");
15
+ const files_1 = require("./versions/files");
16
+ const validation_1 = require("./versions/validation");
15
17
  const sidebars_1 = require("./sidebars");
16
18
  const constants_1 = require("./constants");
17
- const utils_1 = require("@docusaurus/utils");
18
- const logger_1 = tslib_1.__importDefault(require("@docusaurus/logger"));
19
19
  async function createVersionedSidebarFile({ siteDir, pluginId, sidebarPath, version, }) {
20
20
  // Load current sidebar and create a new versioned sidebars file (if needed).
21
21
  // Note: we don't need the sidebars file to be normalized: it's ok to let
package/lib/docs.d.ts CHANGED
@@ -4,10 +4,10 @@
4
4
  * This source code is licensed under the MIT license found in the
5
5
  * LICENSE file in the root directory of this source tree.
6
6
  */
7
+ import type { MetadataOptions, PluginOptions, CategoryIndexMatcher, DocMetadataBase, VersionMetadata, LoadedVersion } from '@docusaurus/plugin-content-docs';
7
8
  import type { LoadContext } from '@docusaurus/types';
8
- import type { DocFile } from './types';
9
9
  import type { SidebarsUtils } from './sidebars/utils';
10
- import type { MetadataOptions, PluginOptions, CategoryIndexMatcher, DocMetadataBase, VersionMetadata, LoadedVersion } from '@docusaurus/plugin-content-docs';
10
+ import type { DocFile } from './types';
11
11
  declare type LastUpdateOptions = Pick<PluginOptions, 'showLastUpdateAuthor' | 'showLastUpdateTime'>;
12
12
  export declare function readDocFile(versionMetadata: Pick<VersionMetadata, 'contentPath' | 'contentPathLocalized'>, source: string, options: LastUpdateOptions): Promise<DocFile>;
13
13
  export declare function readVersionDocs(versionMetadata: VersionMetadata, options: Pick<PluginOptions, 'include' | 'exclude' | 'showLastUpdateAuthor' | 'showLastUpdateTime'>): Promise<DocFile[]>;
package/lib/index.d.ts CHANGED
@@ -4,7 +4,7 @@
4
4
  * This source code is licensed under the MIT license found in the
5
5
  * LICENSE file in the root directory of this source tree.
6
6
  */
7
- import type { LoadContext, Plugin } from '@docusaurus/types';
8
7
  import type { PluginOptions, LoadedContent } from '@docusaurus/plugin-content-docs';
8
+ import type { LoadContext, Plugin } from '@docusaurus/types';
9
9
  export default function pluginContentDocs(context: LoadContext, options: PluginOptions): Promise<Plugin<LoadedContent>>;
10
10
  export { validateOptions } from './options';
package/lib/index.js CHANGED
@@ -9,6 +9,8 @@ Object.defineProperty(exports, "__esModule", { value: true });
9
9
  exports.validateOptions = void 0;
10
10
  const tslib_1 = require("tslib");
11
11
  const path_1 = tslib_1.__importDefault(require("path"));
12
+ const lodash_1 = tslib_1.__importDefault(require("lodash"));
13
+ const logger_1 = tslib_1.__importDefault(require("@docusaurus/logger"));
12
14
  const utils_1 = require("@docusaurus/utils");
13
15
  const sidebars_1 = require("./sidebars");
14
16
  const generator_1 = require("./sidebars/generator");
@@ -20,11 +22,9 @@ const globalData_1 = require("./globalData");
20
22
  const props_1 = require("./props");
21
23
  const categoryGeneratedIndex_1 = require("./categoryGeneratedIndex");
22
24
  const translations_1 = require("./translations");
23
- const logger_1 = tslib_1.__importDefault(require("@docusaurus/logger"));
24
25
  const tags_1 = require("./tags");
25
26
  const routes_1 = require("./routes");
26
27
  const utils_2 = require("./sidebars/utils");
27
- const lodash_1 = tslib_1.__importDefault(require("lodash"));
28
28
  async function pluginContentDocs(context, options) {
29
29
  const { siteDir, generatedFilesDir, baseUrl, siteConfig } = context;
30
30
  // Mutate options to resolve sidebar path according to siteDir
package/lib/options.d.ts CHANGED
@@ -4,7 +4,7 @@
4
4
  * This source code is licensed under the MIT license found in the
5
5
  * LICENSE file in the root directory of this source tree.
6
6
  */
7
- import type { PluginOptions, Options } from '@docusaurus/plugin-content-docs';
8
7
  import type { OptionValidationContext } from '@docusaurus/types';
8
+ import type { PluginOptions, Options } from '@docusaurus/plugin-content-docs';
9
9
  export declare const DEFAULT_OPTIONS: Omit<PluginOptions, 'id' | 'sidebarPath'>;
10
10
  export declare function validateOptions({ validate, options: userOptions, }: OptionValidationContext<Options, PluginOptions>): PluginOptions;
package/lib/options.js CHANGED
@@ -8,9 +8,9 @@
8
8
  Object.defineProperty(exports, "__esModule", { value: true });
9
9
  exports.validateOptions = exports.DEFAULT_OPTIONS = void 0;
10
10
  const tslib_1 = require("tslib");
11
+ const logger_1 = tslib_1.__importDefault(require("@docusaurus/logger"));
11
12
  const utils_validation_1 = require("@docusaurus/utils-validation");
12
13
  const utils_1 = require("@docusaurus/utils");
13
- const logger_1 = tslib_1.__importDefault(require("@docusaurus/logger"));
14
14
  const remark_admonitions_1 = tslib_1.__importDefault(require("remark-admonitions"));
15
15
  const generator_1 = require("./sidebars/generator");
16
16
  const numberPrefix_1 = require("./numberPrefix");
package/lib/routes.js CHANGED
@@ -8,9 +8,9 @@
8
8
  Object.defineProperty(exports, "__esModule", { value: true });
9
9
  exports.createVersionRoutes = exports.createDocRoutes = exports.createCategoryGeneratedIndexRoutes = void 0;
10
10
  const tslib_1 = require("tslib");
11
+ const logger_1 = tslib_1.__importDefault(require("@docusaurus/logger"));
11
12
  const utils_1 = require("@docusaurus/utils");
12
13
  const props_1 = require("./props");
13
- const logger_1 = tslib_1.__importDefault(require("@docusaurus/logger"));
14
14
  async function createCategoryGeneratedIndexRoutes({ version, actions, docCategoryGeneratedIndexComponent, aliasedSource, }) {
15
15
  const slugs = (0, utils_1.createSlugger)();
16
16
  async function createCategoryGeneratedIndexRoute(categoryGeneratedIndex) {
@@ -8,10 +8,10 @@
8
8
  Object.defineProperty(exports, "__esModule", { value: true });
9
9
  exports.DefaultSidebarItemsGenerator = exports.CategoryMetadataFilenamePattern = exports.CategoryMetadataFilenameBase = void 0;
10
10
  const tslib_1 = require("tslib");
11
+ const path_1 = tslib_1.__importDefault(require("path"));
11
12
  const lodash_1 = tslib_1.__importDefault(require("lodash"));
12
- const utils_1 = require("@docusaurus/utils");
13
13
  const logger_1 = tslib_1.__importDefault(require("@docusaurus/logger"));
14
- const path_1 = tslib_1.__importDefault(require("path"));
14
+ const utils_1 = require("@docusaurus/utils");
15
15
  const docs_1 = require("../docs");
16
16
  const BreadcrumbSeparator = '/';
17
17
  // Just an alias to the make code more explicit
@@ -4,8 +4,8 @@
4
4
  * This source code is licensed under the MIT license found in the
5
5
  * LICENSE file in the root directory of this source tree.
6
6
  */
7
- import type { SidebarsConfig, Sidebars, SidebarProcessorParams } from './types';
8
7
  import type { PluginOptions } from '@docusaurus/plugin-content-docs';
8
+ import type { SidebarsConfig, Sidebars, SidebarProcessorParams } from './types';
9
9
  export declare const DefaultSidebars: SidebarsConfig;
10
10
  export declare const DisabledSidebars: SidebarsConfig;
11
11
  export declare function resolveSidebarPathOption(siteDir: string, sidebarPathOption: PluginOptions['sidebarPath']): PluginOptions['sidebarPath'];
@@ -9,17 +9,17 @@ Object.defineProperty(exports, "__esModule", { value: true });
9
9
  exports.loadSidebars = exports.loadSidebarsFileUnsafe = exports.resolveSidebarPathOption = exports.DisabledSidebars = exports.DefaultSidebars = void 0;
10
10
  const tslib_1 = require("tslib");
11
11
  const fs_extra_1 = tslib_1.__importDefault(require("fs-extra"));
12
+ const path_1 = tslib_1.__importDefault(require("path"));
13
+ const lodash_1 = tslib_1.__importDefault(require("lodash"));
14
+ const logger_1 = tslib_1.__importDefault(require("@docusaurus/logger"));
15
+ const utils_1 = require("@docusaurus/utils");
16
+ const js_yaml_1 = tslib_1.__importDefault(require("js-yaml"));
17
+ const combine_promises_1 = tslib_1.__importDefault(require("combine-promises"));
12
18
  const import_fresh_1 = tslib_1.__importDefault(require("import-fresh"));
13
19
  const validation_1 = require("./validation");
14
20
  const normalization_1 = require("./normalization");
15
21
  const processor_1 = require("./processor");
16
22
  const postProcessor_1 = require("./postProcessor");
17
- const path_1 = tslib_1.__importDefault(require("path"));
18
- const utils_1 = require("@docusaurus/utils");
19
- const logger_1 = tslib_1.__importDefault(require("@docusaurus/logger"));
20
- const js_yaml_1 = tslib_1.__importDefault(require("js-yaml"));
21
- const lodash_1 = tslib_1.__importDefault(require("lodash"));
22
- const combine_promises_1 = tslib_1.__importDefault(require("combine-promises"));
23
23
  exports.DefaultSidebars = {
24
24
  defaultSidebar: [
25
25
  {
@@ -8,9 +8,9 @@
8
8
  Object.defineProperty(exports, "__esModule", { value: true });
9
9
  exports.normalizeSidebars = exports.normalizeItem = void 0;
10
10
  const tslib_1 = require("tslib");
11
- const utils_1 = require("./utils");
12
11
  const lodash_1 = tslib_1.__importDefault(require("lodash"));
13
12
  const logger_1 = tslib_1.__importDefault(require("@docusaurus/logger"));
13
+ const utils_1 = require("./utils");
14
14
  function normalizeCategoriesShorthand(sidebar) {
15
15
  return Object.entries(sidebar).map(([label, items]) => ({
16
16
  type: 'category',
@@ -8,9 +8,9 @@
8
8
  Object.defineProperty(exports, "__esModule", { value: true });
9
9
  exports.postProcessSidebars = void 0;
10
10
  const tslib_1 = require("tslib");
11
+ const lodash_1 = tslib_1.__importDefault(require("lodash"));
11
12
  const utils_1 = require("@docusaurus/utils");
12
13
  const docs_1 = require("../docs");
13
- const lodash_1 = tslib_1.__importDefault(require("lodash"));
14
14
  function normalizeCategoryLink(category, params) {
15
15
  if (category.link?.type === 'doc' && params.draftIds.has(category.link.id)) {
16
16
  return undefined;
@@ -8,10 +8,10 @@
8
8
  Object.defineProperty(exports, "__esModule", { value: true });
9
9
  exports.processSidebars = void 0;
10
10
  const tslib_1 = require("tslib");
11
- const generator_1 = require("./generator");
12
- const validation_1 = require("./validation");
13
11
  const lodash_1 = tslib_1.__importDefault(require("lodash"));
14
12
  const combine_promises_1 = tslib_1.__importDefault(require("combine-promises"));
13
+ const generator_1 = require("./generator");
14
+ const validation_1 = require("./validation");
15
15
  const docs_1 = require("../docs");
16
16
  function toSidebarItemsGeneratorDoc(doc) {
17
17
  return lodash_1.default.pick(doc, [
package/lib/tags.js CHANGED
@@ -8,8 +8,8 @@
8
8
  Object.defineProperty(exports, "__esModule", { value: true });
9
9
  exports.getVersionTags = void 0;
10
10
  const tslib_1 = require("tslib");
11
- const utils_1 = require("@docusaurus/utils");
12
11
  const lodash_1 = tslib_1.__importDefault(require("lodash"));
12
+ const utils_1 = require("@docusaurus/utils");
13
13
  function getVersionTags(docs) {
14
14
  const groups = (0, utils_1.groupTaggedItems)(docs, (doc) => doc.tags);
15
15
  return lodash_1.default.mapValues(groups, (group) => ({
@@ -9,9 +9,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
9
9
  exports.translateLoadedContent = exports.getLoadedContentTranslationFiles = void 0;
10
10
  const tslib_1 = require("tslib");
11
11
  const lodash_1 = tslib_1.__importDefault(require("lodash"));
12
- const utils_1 = require("./sidebars/utils");
13
- const utils_2 = require("@docusaurus/utils");
12
+ const utils_1 = require("@docusaurus/utils");
14
13
  const constants_1 = require("./constants");
14
+ const utils_2 = require("./sidebars/utils");
15
15
  function getVersionFileName(versionName) {
16
16
  if (versionName === constants_1.CURRENT_VERSION_NAME) {
17
17
  return versionName;
@@ -31,7 +31,7 @@ function getNormalizedSidebarName({ versionName, sidebarName, }) {
31
31
  return rest.join('/');
32
32
  }
33
33
  function getSidebarTranslationFileContent(sidebar, sidebarName) {
34
- const categories = (0, utils_1.collectSidebarCategories)(sidebar);
34
+ const categories = (0, utils_2.collectSidebarCategories)(sidebar);
35
35
  const categoryContent = Object.fromEntries(categories.flatMap((category) => {
36
36
  const entries = [];
37
37
  entries.push([
@@ -63,7 +63,7 @@ function getSidebarTranslationFileContent(sidebar, sidebarName) {
63
63
  }
64
64
  return entries;
65
65
  }));
66
- const links = (0, utils_1.collectSidebarLinks)(sidebar);
66
+ const links = (0, utils_2.collectSidebarLinks)(sidebar);
67
67
  const linksContent = Object.fromEntries(links.map((link) => [
68
68
  `sidebar.${sidebarName}.link.${link.label}`,
69
69
  {
@@ -71,7 +71,7 @@ function getSidebarTranslationFileContent(sidebar, sidebarName) {
71
71
  description: `The label for link ${link.label} in sidebar ${sidebarName}, linking to ${link.href}`,
72
72
  },
73
73
  ]));
74
- return (0, utils_2.mergeTranslations)([categoryContent, linksContent]);
74
+ return (0, utils_1.mergeTranslations)([categoryContent, linksContent]);
75
75
  }
76
76
  function translateSidebar({ sidebar, sidebarName, sidebarsTranslations, }) {
77
77
  function transformSidebarCategoryLink(category) {
@@ -89,7 +89,7 @@ function translateSidebar({ sidebar, sidebarName, sidebarsTranslations, }) {
89
89
  }
90
90
  return category.link;
91
91
  }
92
- return (0, utils_1.transformSidebarItems)(sidebar, (item) => {
92
+ return (0, utils_2.transformSidebarItems)(sidebar, (item) => {
93
93
  if (item.type === 'category') {
94
94
  const link = transformSidebarCategoryLink(item);
95
95
  return {
@@ -110,7 +110,7 @@ function translateSidebar({ sidebar, sidebarName, sidebarsTranslations, }) {
110
110
  });
111
111
  }
112
112
  function getSidebarsTranslations(version) {
113
- return (0, utils_2.mergeTranslations)(Object.entries(version.sidebars).map(([sidebarName, sidebar]) => {
113
+ return (0, utils_1.mergeTranslations)(Object.entries(version.sidebars).map(([sidebarName, sidebar]) => {
114
114
  const normalizedSidebarName = getNormalizedSidebarName({
115
115
  sidebarName,
116
116
  versionName: version.versionName,
@@ -139,7 +139,7 @@ function getVersionTranslationFiles(version) {
139
139
  return [
140
140
  {
141
141
  path: getVersionFileName(version.versionName),
142
- content: (0, utils_2.mergeTranslations)([versionTranslations, sidebarsTranslations]),
142
+ content: (0, utils_1.mergeTranslations)([versionTranslations, sidebarsTranslations]),
143
143
  },
144
144
  ];
145
145
  }
@@ -10,9 +10,9 @@ exports.getVersionMetadataPaths = exports.readVersionNames = exports.getVersions
10
10
  const tslib_1 = require("tslib");
11
11
  const path_1 = tslib_1.__importDefault(require("path"));
12
12
  const fs_extra_1 = tslib_1.__importDefault(require("fs-extra"));
13
+ const utils_1 = require("@docusaurus/utils");
13
14
  const constants_1 = require("../constants");
14
15
  const validation_1 = require("./validation");
15
- const utils_1 = require("@docusaurus/utils");
16
16
  /** Add a prefix like `community_version-1.0.0`. No-op for default instance. */
17
17
  function addPluginIdPrefix(fileOrDir, pluginId) {
18
18
  return pluginId === utils_1.DEFAULT_PLUGIN_ID
@@ -9,8 +9,8 @@ Object.defineProperty(exports, "__esModule", { value: true });
9
9
  exports.readVersionsMetadata = exports.filterVersions = exports.getVersionBadge = exports.getVersionBanner = exports.getDefaultVersionBanner = void 0;
10
10
  const tslib_1 = require("tslib");
11
11
  const path_1 = tslib_1.__importDefault(require("path"));
12
- const constants_1 = require("../constants");
13
12
  const utils_1 = require("@docusaurus/utils");
13
+ const constants_1 = require("../constants");
14
14
  const validation_1 = require("./validation");
15
15
  const files_1 = require("./files");
16
16
  function getVersionEditUrls({ contentPath, contentPathLocalized, context, options, }) {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@docusaurus/plugin-content-docs",
3
- "version": "0.0.0-5008",
3
+ "version": "0.0.0-5012",
4
4
  "description": "Docs plugin for Docusaurus.",
5
5
  "main": "lib/index.js",
6
6
  "sideEffects": false,
@@ -25,11 +25,11 @@
25
25
  },
26
26
  "license": "MIT",
27
27
  "dependencies": {
28
- "@docusaurus/core": "0.0.0-5008",
29
- "@docusaurus/logger": "0.0.0-5008",
30
- "@docusaurus/mdx-loader": "0.0.0-5008",
31
- "@docusaurus/utils": "0.0.0-5008",
32
- "@docusaurus/utils-validation": "0.0.0-5008",
28
+ "@docusaurus/core": "0.0.0-5012",
29
+ "@docusaurus/logger": "0.0.0-5012",
30
+ "@docusaurus/mdx-loader": "0.0.0-5012",
31
+ "@docusaurus/utils": "0.0.0-5012",
32
+ "@docusaurus/utils-validation": "0.0.0-5012",
33
33
  "combine-promises": "^1.1.0",
34
34
  "fs-extra": "^10.1.0",
35
35
  "import-fresh": "^3.3.0",
@@ -41,8 +41,8 @@
41
41
  "webpack": "^5.72.1"
42
42
  },
43
43
  "devDependencies": {
44
- "@docusaurus/module-type-aliases": "0.0.0-5008",
45
- "@docusaurus/types": "0.0.0-5008",
44
+ "@docusaurus/module-type-aliases": "0.0.0-5012",
45
+ "@docusaurus/types": "0.0.0-5012",
46
46
  "@types/js-yaml": "^4.0.5",
47
47
  "@types/picomatch": "^2.3.0",
48
48
  "commander": "^5.1.0",
@@ -58,5 +58,5 @@
58
58
  "engines": {
59
59
  "node": ">=14"
60
60
  },
61
- "gitHead": "240ae8300c8a16a1ff854aac3a62456ca00855c0"
61
+ "gitHead": "23b7a134145506adf6db87c8e81640e3633c13ec"
62
62
  }
@@ -5,13 +5,13 @@
5
5
  * LICENSE file in the root directory of this source tree.
6
6
  */
7
7
 
8
+ import {type SidebarsUtils, toNavigationLink} from './sidebars/utils';
9
+ import {createDocsByIdIndex} from './docs';
8
10
  import type {
9
11
  CategoryGeneratedIndexMetadata,
10
12
  DocMetadataBase,
11
13
  } from '@docusaurus/plugin-content-docs';
12
14
  import type {SidebarItemCategoryWithGeneratedIndex} from './sidebars/types';
13
- import {type SidebarsUtils, toNavigationLink} from './sidebars/utils';
14
- import {createDocsByIdIndex} from './docs';
15
15
 
16
16
  function getCategoryGeneratedIndexMetadata({
17
17
  category,
package/src/cli.ts CHANGED
@@ -5,6 +5,10 @@
5
5
  * LICENSE file in the root directory of this source tree.
6
6
  */
7
7
 
8
+ import fs from 'fs-extra';
9
+ import path from 'path';
10
+ import logger from '@docusaurus/logger';
11
+ import {DEFAULT_PLUGIN_ID} from '@docusaurus/utils';
8
12
  import {
9
13
  getVersionsFilePath,
10
14
  getVersionDocsDirPath,
@@ -12,13 +16,9 @@ import {
12
16
  getDocsDirPathLocalized,
13
17
  } from './versions/files';
14
18
  import {validateVersionName} from './versions/validation';
15
- import fs from 'fs-extra';
16
- import path from 'path';
17
- import type {PluginOptions} from '@docusaurus/plugin-content-docs';
18
19
  import {loadSidebarsFileUnsafe} from './sidebars';
19
20
  import {CURRENT_VERSION_NAME} from './constants';
20
- import {DEFAULT_PLUGIN_ID} from '@docusaurus/utils';
21
- import logger from '@docusaurus/logger';
21
+ import type {PluginOptions} from '@docusaurus/plugin-content-docs';
22
22
  import type {LoadContext} from '@docusaurus/types';
23
23
 
24
24
  async function createVersionedSidebarFile({
package/src/docs.ts CHANGED
@@ -19,15 +19,12 @@ import {
19
19
  Globby,
20
20
  normalizeFrontMatterTags,
21
21
  } from '@docusaurus/utils';
22
- import type {LoadContext} from '@docusaurus/types';
23
22
 
24
23
  import {getFileLastUpdate} from './lastUpdate';
25
- import type {DocFile} from './types';
26
24
  import getSlug from './slug';
27
25
  import {CURRENT_VERSION_NAME} from './constants';
28
26
  import {stripPathNumberPrefixes} from './numberPrefix';
29
27
  import {validateDocFrontMatter} from './frontMatter';
30
- import type {SidebarsUtils} from './sidebars/utils';
31
28
  import {toDocNavigationLink, toNavigationLink} from './sidebars/utils';
32
29
  import type {
33
30
  MetadataOptions,
@@ -41,6 +38,9 @@ import type {
41
38
  DocFrontMatter,
42
39
  LoadedVersion,
43
40
  } from '@docusaurus/plugin-content-docs';
41
+ import type {LoadContext} from '@docusaurus/types';
42
+ import type {SidebarsUtils} from './sidebars/utils';
43
+ import type {DocFile} from './types';
44
44
 
45
45
  type LastUpdateOptions = Pick<
46
46
  PluginOptions,
package/src/globalData.ts CHANGED
@@ -6,7 +6,6 @@
6
6
  */
7
7
 
8
8
  import _ from 'lodash';
9
- import type {Sidebars} from './sidebars/types';
10
9
  import {getMainDocId} from './docs';
11
10
  import type {FullVersion} from './types';
12
11
  import type {
@@ -18,6 +17,7 @@ import type {
18
17
  GlobalSidebar,
19
18
  GlobalDoc,
20
19
  } from '@docusaurus/plugin-content-docs/client';
20
+ import type {Sidebars} from './sidebars/types';
21
21
 
22
22
  function toGlobalDataDoc(doc: DocMetadata): GlobalDoc {
23
23
  return {
package/src/index.ts CHANGED
@@ -6,7 +6,8 @@
6
6
  */
7
7
 
8
8
  import path from 'path';
9
-
9
+ import _ from 'lodash';
10
+ import logger from '@docusaurus/logger';
10
11
  import {
11
12
  normalizeUrl,
12
13
  docuHash,
@@ -19,20 +20,15 @@ import {
19
20
  createSlugger,
20
21
  DEFAULT_PLUGIN_ID,
21
22
  } from '@docusaurus/utils';
22
- import type {LoadContext, Plugin} from '@docusaurus/types';
23
23
  import {loadSidebars, resolveSidebarPathOption} from './sidebars';
24
24
  import {CategoryMetadataFilenamePattern} from './sidebars/generator';
25
- import type {DocEnv} from './docs';
26
- import {readVersionDocs, processDocMetadata, addDocNavigation} from './docs';
25
+ import {
26
+ readVersionDocs,
27
+ processDocMetadata,
28
+ addDocNavigation,
29
+ type DocEnv,
30
+ } from './docs';
27
31
  import {readVersionsMetadata} from './versions';
28
- import type {
29
- SourceToPermalink,
30
- DocFile,
31
- DocsMarkdownOption,
32
- VersionTag,
33
- FullVersion,
34
- } from './types';
35
- import type {RuleSetRule} from 'webpack';
36
32
  import {cliDocsVersionCommand} from './cli';
37
33
  import {VERSIONS_JSON_FILE} from './constants';
38
34
  import {toGlobalDataVersion} from './globalData';
@@ -42,9 +38,10 @@ import {
42
38
  translateLoadedContent,
43
39
  getLoadedContentTranslationFiles,
44
40
  } from './translations';
45
- import logger from '@docusaurus/logger';
46
41
  import {getVersionTags} from './tags';
47
42
  import {createVersionRoutes} from './routes';
43
+ import {createSidebarsUtils} from './sidebars/utils';
44
+
48
45
  import type {
49
46
  PropTagsListPage,
50
47
  PluginOptions,
@@ -54,8 +51,15 @@ import type {
54
51
  LoadedContent,
55
52
  LoadedVersion,
56
53
  } from '@docusaurus/plugin-content-docs';
57
- import {createSidebarsUtils} from './sidebars/utils';
58
- import _ from 'lodash';
54
+ import type {LoadContext, Plugin} from '@docusaurus/types';
55
+ import type {
56
+ SourceToPermalink,
57
+ DocFile,
58
+ DocsMarkdownOption,
59
+ VersionTag,
60
+ FullVersion,
61
+ } from './types';
62
+ import type {RuleSetRule} from 'webpack';
59
63
 
60
64
  export default async function pluginContentDocs(
61
65
  context: LoadContext,
@@ -5,8 +5,8 @@
5
5
  * LICENSE file in the root directory of this source tree.
6
6
  */
7
7
 
8
- import type {DocsMarkdownOption} from '../types';
9
8
  import {replaceMarkdownLinks, getContentPathList} from '@docusaurus/utils';
9
+ import type {DocsMarkdownOption} from '../types';
10
10
 
11
11
  function getVersion(filePath: string, options: DocsMarkdownOption) {
12
12
  const versionFound = options.versionsMetadata.find((version) =>
package/src/options.ts CHANGED
@@ -5,7 +5,7 @@
5
5
  * LICENSE file in the root directory of this source tree.
6
6
  */
7
7
 
8
- import type {PluginOptions, Options} from '@docusaurus/plugin-content-docs';
8
+ import logger from '@docusaurus/logger';
9
9
  import {
10
10
  Joi,
11
11
  RemarkPluginsSchema,
@@ -14,15 +14,14 @@ import {
14
14
  URISchema,
15
15
  } from '@docusaurus/utils-validation';
16
16
  import {GlobExcludeDefault} from '@docusaurus/utils';
17
-
18
- import type {OptionValidationContext} from '@docusaurus/types';
19
- import logger from '@docusaurus/logger';
20
17
  import admonitions from 'remark-admonitions';
21
18
  import {DefaultSidebarItemsGenerator} from './sidebars/generator';
22
19
  import {
23
20
  DefaultNumberPrefixParser,
24
21
  DisabledNumberPrefixParser,
25
22
  } from './numberPrefix';
23
+ import type {OptionValidationContext} from '@docusaurus/types';
24
+ import type {PluginOptions, Options} from '@docusaurus/plugin-content-docs';
26
25
 
27
26
  export const DEFAULT_OPTIONS: Omit<PluginOptions, 'id' | 'sidebarPath'> = {
28
27
  path: 'docs', // Path to data on filesystem, relative to site dir.
package/src/props.ts CHANGED
@@ -5,6 +5,8 @@
5
5
  * LICENSE file in the root directory of this source tree.
6
6
  */
7
7
 
8
+ import _ from 'lodash';
9
+ import {createDocsByIdIndex} from './docs';
8
10
  import type {VersionTag} from './types';
9
11
  import type {
10
12
  SidebarItemDoc,
@@ -24,8 +26,6 @@ import type {
24
26
  DocMetadata,
25
27
  LoadedVersion,
26
28
  } from '@docusaurus/plugin-content-docs';
27
- import _ from 'lodash';
28
- import {createDocsByIdIndex} from './docs';
29
29
 
30
30
  export function toSidebarsProp(loadedVersion: LoadedVersion): PropSidebars {
31
31
  const docsById = createDocsByIdIndex(loadedVersion.docs);
package/src/routes.ts CHANGED
@@ -5,15 +5,15 @@
5
5
  * LICENSE file in the root directory of this source tree.
6
6
  */
7
7
 
8
- import type {PluginContentLoadedActions, RouteConfig} from '@docusaurus/types';
8
+ import logger from '@docusaurus/logger';
9
9
  import {docuHash, createSlugger} from '@docusaurus/utils';
10
+ import {toVersionMetadataProp} from './props';
11
+ import type {PluginContentLoadedActions, RouteConfig} from '@docusaurus/types';
10
12
  import type {FullVersion} from './types';
11
13
  import type {
12
14
  CategoryGeneratedIndexMetadata,
13
15
  DocMetadata,
14
16
  } from '@docusaurus/plugin-content-docs';
15
- import {toVersionMetadataProp} from './props';
16
- import logger from '@docusaurus/logger';
17
17
 
18
18
  export async function createCategoryGeneratedIndexRoutes({
19
19
  version,
@@ -5,6 +5,11 @@
5
5
  * LICENSE file in the root directory of this source tree.
6
6
  */
7
7
 
8
+ import path from 'path';
9
+ import _ from 'lodash';
10
+ import logger from '@docusaurus/logger';
11
+ import {addTrailingSlash} from '@docusaurus/utils';
12
+ import {createDocsByIdIndex, toCategoryIndexMatcherParam} from '../docs';
8
13
  import type {
9
14
  SidebarItemDoc,
10
15
  SidebarItemsGenerator,
@@ -13,11 +18,6 @@ import type {
13
18
  NormalizedSidebarItem,
14
19
  SidebarItemCategoryLinkConfig,
15
20
  } from './types';
16
- import _ from 'lodash';
17
- import {addTrailingSlash} from '@docusaurus/utils';
18
- import logger from '@docusaurus/logger';
19
- import path from 'path';
20
- import {createDocsByIdIndex, toCategoryIndexMatcherParam} from '../docs';
21
21
 
22
22
  const BreadcrumbSeparator = '/';
23
23
 
@@ -6,19 +6,19 @@
6
6
  */
7
7
 
8
8
  import fs from 'fs-extra';
9
+ import path from 'path';
10
+ import _ from 'lodash';
11
+ import logger from '@docusaurus/logger';
12
+ import {Globby} from '@docusaurus/utils';
13
+ import Yaml from 'js-yaml';
14
+ import combinePromises from 'combine-promises';
9
15
  import importFresh from 'import-fresh';
10
- import type {SidebarsConfig, Sidebars, SidebarProcessorParams} from './types';
11
16
  import {validateSidebars, validateCategoryMetadataFile} from './validation';
12
17
  import {normalizeSidebars} from './normalization';
13
18
  import {processSidebars} from './processor';
14
19
  import {postProcessSidebars} from './postProcessor';
15
- import path from 'path';
16
- import {Globby} from '@docusaurus/utils';
17
- import logger from '@docusaurus/logger';
18
20
  import type {PluginOptions} from '@docusaurus/plugin-content-docs';
19
- import Yaml from 'js-yaml';
20
- import _ from 'lodash';
21
- import combinePromises from 'combine-promises';
21
+ import type {SidebarsConfig, Sidebars, SidebarProcessorParams} from './types';
22
22
 
23
23
  export const DefaultSidebars: SidebarsConfig = {
24
24
  defaultSidebar: [
@@ -5,6 +5,9 @@
5
5
  * LICENSE file in the root directory of this source tree.
6
6
  */
7
7
 
8
+ import _ from 'lodash';
9
+ import logger from '@docusaurus/logger';
10
+ import {isCategoriesShorthand} from './utils';
8
11
  import type {
9
12
  NormalizedSidebarItem,
10
13
  NormalizedSidebar,
@@ -16,9 +19,6 @@ import type {
16
19
  SidebarsConfig,
17
20
  NormalizedSidebarItemCategory,
18
21
  } from './types';
19
- import {isCategoriesShorthand} from './utils';
20
- import _ from 'lodash';
21
- import logger from '@docusaurus/logger';
22
22
 
23
23
  function normalizeCategoriesShorthand(
24
24
  sidebar: SidebarCategoriesShorthand,
@@ -5,7 +5,9 @@
5
5
  * LICENSE file in the root directory of this source tree.
6
6
  */
7
7
 
8
+ import _ from 'lodash';
8
9
  import {normalizeUrl} from '@docusaurus/utils';
10
+ import {getDocIds} from '../docs';
9
11
  import type {
10
12
  SidebarItem,
11
13
  Sidebars,
@@ -15,8 +17,6 @@ import type {
15
17
  ProcessedSidebars,
16
18
  SidebarItemCategoryLink,
17
19
  } from './types';
18
- import {getDocIds} from '../docs';
19
- import _ from 'lodash';
20
20
 
21
21
  type SidebarPostProcessorParams = SidebarProcessorParams & {
22
22
  draftIds: Set<string>;
@@ -5,6 +5,11 @@
5
5
  * LICENSE file in the root directory of this source tree.
6
6
  */
7
7
 
8
+ import _ from 'lodash';
9
+ import combinePromises from 'combine-promises';
10
+ import {DefaultSidebarItemsGenerator} from './generator';
11
+ import {validateSidebars} from './validation';
12
+ import {isCategoryIndex} from '../docs';
8
13
  import type {
9
14
  DocMetadataBase,
10
15
  VersionMetadata,
@@ -22,11 +27,6 @@ import type {
22
27
  SidebarProcessorParams,
23
28
  CategoryMetadataFile,
24
29
  } from './types';
25
- import {DefaultSidebarItemsGenerator} from './generator';
26
- import {validateSidebars} from './validation';
27
- import _ from 'lodash';
28
- import combinePromises from 'combine-promises';
29
- import {isCategoryIndex} from '../docs';
30
30
 
31
31
  function toSidebarItemsGeneratorDoc(
32
32
  doc: DocMetadataBase,
@@ -5,6 +5,8 @@
5
5
  * LICENSE file in the root directory of this source tree.
6
6
  */
7
7
 
8
+ import _ from 'lodash';
9
+ import {toMessageRelativeFilePath} from '@docusaurus/utils';
8
10
  import type {
9
11
  Sidebars,
10
12
  Sidebar,
@@ -18,9 +20,6 @@ import type {
18
20
  SidebarItemCategoryWithGeneratedIndex,
19
21
  SidebarNavigationItem,
20
22
  } from './types';
21
-
22
- import _ from 'lodash';
23
- import {toMessageRelativeFilePath} from '@docusaurus/utils';
24
23
  import type {
25
24
  DocMetadataBase,
26
25
  PropNavigationLink,
package/src/tags.ts CHANGED
@@ -5,10 +5,10 @@
5
5
  * LICENSE file in the root directory of this source tree.
6
6
  */
7
7
 
8
+ import _ from 'lodash';
8
9
  import {groupTaggedItems} from '@docusaurus/utils';
9
10
  import type {VersionTags} from './types';
10
11
  import type {DocMetadata} from '@docusaurus/plugin-content-docs';
11
- import _ from 'lodash';
12
12
 
13
13
  export function getVersionTags(docs: DocMetadata[]): VersionTags {
14
14
  const groups = groupTaggedItems(docs, (doc) => doc.tags);
@@ -5,6 +5,14 @@
5
5
  * LICENSE file in the root directory of this source tree.
6
6
  */
7
7
 
8
+ import _ from 'lodash';
9
+ import {mergeTranslations} from '@docusaurus/utils';
10
+ import {CURRENT_VERSION_NAME} from './constants';
11
+ import {
12
+ collectSidebarCategories,
13
+ transformSidebarItems,
14
+ collectSidebarLinks,
15
+ } from './sidebars/utils';
8
16
  import type {
9
17
  LoadedVersion,
10
18
  LoadedContent,
@@ -15,20 +23,11 @@ import type {
15
23
  SidebarItemCategoryLink,
16
24
  Sidebars,
17
25
  } from './sidebars/types';
18
-
19
- import _ from 'lodash';
20
- import {
21
- collectSidebarCategories,
22
- transformSidebarItems,
23
- collectSidebarLinks,
24
- } from './sidebars/utils';
25
26
  import type {
26
27
  TranslationFileContent,
27
28
  TranslationFile,
28
29
  TranslationMessage,
29
30
  } from '@docusaurus/types';
30
- import {mergeTranslations} from '@docusaurus/utils';
31
- import {CURRENT_VERSION_NAME} from './constants';
32
31
 
33
32
  function getVersionFileName(versionName: string): string {
34
33
  if (versionName === CURRENT_VERSION_NAME) {
@@ -7,6 +7,7 @@
7
7
 
8
8
  import path from 'path';
9
9
  import fs from 'fs-extra';
10
+ import {getPluginI18nPath, DEFAULT_PLUGIN_ID} from '@docusaurus/utils';
10
11
  import {
11
12
  VERSIONS_JSON_FILE,
12
13
  VERSIONED_DOCS_DIR,
@@ -14,7 +15,6 @@ import {
14
15
  CURRENT_VERSION_NAME,
15
16
  } from '../constants';
16
17
  import {validateVersionNames} from './validation';
17
- import {getPluginI18nPath, DEFAULT_PLUGIN_ID} from '@docusaurus/utils';
18
18
  import type {
19
19
  PluginOptions,
20
20
  VersionMetadata,
@@ -6,8 +6,8 @@
6
6
  */
7
7
 
8
8
  import path from 'path';
9
- import {CURRENT_VERSION_NAME} from '../constants';
10
9
  import {normalizeUrl, posixPath} from '@docusaurus/utils';
10
+ import {CURRENT_VERSION_NAME} from '../constants';
11
11
  import {validateVersionsOptions} from './validation';
12
12
  import {
13
13
  getDocsDirPathLocalized,