@docusaurus/plugin-content-docs 0.0.0-5913 → 0.0.0-5917
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/categoryGeneratedIndex.d.ts +1 -0
- package/lib/cli.d.ts +1 -0
- package/lib/docs.d.ts +1 -0
- package/lib/frontMatter.d.ts +1 -0
- package/lib/index.d.ts +1 -0
- package/lib/numberPrefix.d.ts +1 -0
- package/lib/options.d.ts +1 -0
- package/lib/options.js +4 -4
- package/lib/props.d.ts +1 -0
- package/lib/routes.d.ts +1 -0
- package/lib/sidebars/index.d.ts +1 -0
- package/lib/sidebars/types.d.ts +1 -0
- package/lib/sidebars/utils.d.ts +1 -0
- package/lib/slug.d.ts +1 -0
- package/lib/tags.d.ts +1 -0
- package/lib/translations.d.ts +1 -0
- package/lib/types.d.ts +1 -0
- package/lib/versions/files.d.ts +1 -0
- package/lib/versions/index.d.ts +1 -0
- package/lib/versions/validation.d.ts +1 -0
- package/package.json +10 -10
|
@@ -4,6 +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
|
+
/// <reference path="../src/plugin-content-docs.d.ts" />
|
|
7
8
|
import { type SidebarsUtils } from './sidebars/utils';
|
|
8
9
|
import type { CategoryGeneratedIndexMetadata, DocMetadataBase } from '@docusaurus/plugin-content-docs';
|
|
9
10
|
export declare function getCategoryGeneratedIndexMetadataList({ docs, sidebarsUtils, }: {
|
package/lib/cli.d.ts
CHANGED
|
@@ -4,6 +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
|
+
/// <reference path="../src/plugin-content-docs.d.ts" />
|
|
7
8
|
import type { PluginOptions } from '@docusaurus/plugin-content-docs';
|
|
8
9
|
import type { LoadContext } from '@docusaurus/types';
|
|
9
10
|
export declare function cliDocsVersionCommand(version: unknown, { id: pluginId, path: docsPath, sidebarPath }: PluginOptions, { siteDir, i18n }: LoadContext): Promise<void>;
|
package/lib/docs.d.ts
CHANGED
|
@@ -4,6 +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
|
+
/// <reference path="../src/plugin-content-docs.d.ts" />
|
|
7
8
|
import type { MetadataOptions, PluginOptions, CategoryIndexMatcher, DocMetadataBase, VersionMetadata, LoadedVersion } from '@docusaurus/plugin-content-docs';
|
|
8
9
|
import type { LoadContext } from '@docusaurus/types';
|
|
9
10
|
import type { SidebarsUtils } from './sidebars/utils';
|
package/lib/frontMatter.d.ts
CHANGED
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
/// <reference path="../src/plugin-content-docs.d.ts" />
|
|
1
2
|
import type { DocFrontMatter } from '@docusaurus/plugin-content-docs';
|
|
2
3
|
export declare const DocFrontMatterSchema: import("joi").ObjectSchema<DocFrontMatter>;
|
|
3
4
|
export declare function validateDocFrontMatter(frontMatter: {
|
package/lib/index.d.ts
CHANGED
|
@@ -4,6 +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
|
+
/// <reference path="../src/plugin-content-docs.d.ts" />
|
|
7
8
|
import type { PluginOptions, LoadedContent } from '@docusaurus/plugin-content-docs';
|
|
8
9
|
import type { LoadContext, Plugin } from '@docusaurus/types';
|
|
9
10
|
export default function pluginContentDocs(context: LoadContext, options: PluginOptions): Promise<Plugin<LoadedContent>>;
|
package/lib/numberPrefix.d.ts
CHANGED
|
@@ -4,6 +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
|
+
/// <reference path="../src/plugin-content-docs.d.ts" />
|
|
7
8
|
import type { NumberPrefixParser } from '@docusaurus/plugin-content-docs';
|
|
8
9
|
export declare const DefaultNumberPrefixParser: NumberPrefixParser;
|
|
9
10
|
export declare const DisabledNumberPrefixParser: NumberPrefixParser;
|
package/lib/options.d.ts
CHANGED
|
@@ -4,6 +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
|
+
/// <reference path="../src/plugin-content-docs.d.ts" />
|
|
7
8
|
import type { OptionValidationContext } from '@docusaurus/types';
|
|
8
9
|
import type { PluginOptions, Options } from '@docusaurus/plugin-content-docs';
|
|
9
10
|
export declare const DEFAULT_OPTIONS: Omit<PluginOptions, 'id' | 'sidebarPath'>;
|
package/lib/options.js
CHANGED
|
@@ -14,10 +14,10 @@ const utils_1 = require("@docusaurus/utils");
|
|
|
14
14
|
const generator_1 = require("./sidebars/generator");
|
|
15
15
|
const numberPrefix_1 = require("./numberPrefix");
|
|
16
16
|
exports.DEFAULT_OPTIONS = {
|
|
17
|
-
path: 'docs',
|
|
18
|
-
routeBasePath: 'docs',
|
|
19
|
-
tagsBasePath: 'tags',
|
|
20
|
-
include: ['**/*.{md,mdx}'],
|
|
17
|
+
path: 'docs', // Path to data on filesystem, relative to site dir.
|
|
18
|
+
routeBasePath: 'docs', // URL Route.
|
|
19
|
+
tagsBasePath: 'tags', // URL Tags Route.
|
|
20
|
+
include: ['**/*.{md,mdx}'], // Extensions to include.
|
|
21
21
|
exclude: utils_1.GlobExcludeDefault,
|
|
22
22
|
sidebarItemsGenerator: generator_1.DefaultSidebarItemsGenerator,
|
|
23
23
|
numberPrefixParser: numberPrefix_1.DefaultNumberPrefixParser,
|
package/lib/props.d.ts
CHANGED
|
@@ -4,6 +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
|
+
/// <reference path="../src/plugin-content-docs.d.ts" />
|
|
7
8
|
import type { VersionTag, VersionTags } from './types';
|
|
8
9
|
import type { SidebarItemDoc } from './sidebars/types';
|
|
9
10
|
import type { PropSidebars, PropVersionMetadata, PropTagDocList, PropTagsListPage, PropSidebarItemLink, DocMetadata, LoadedVersion } from '@docusaurus/plugin-content-docs';
|
package/lib/routes.d.ts
CHANGED
|
@@ -4,6 +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
|
+
/// <reference path="../src/plugin-content-docs.d.ts" />
|
|
7
8
|
import type { PluginContentLoadedActions, RouteConfig } from '@docusaurus/types';
|
|
8
9
|
import type { FullVersion } from './types';
|
|
9
10
|
import type { PluginOptions } from '@docusaurus/plugin-content-docs';
|
package/lib/sidebars/index.d.ts
CHANGED
|
@@ -4,6 +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
|
+
/// <reference path="../../src/plugin-content-docs.d.ts" />
|
|
7
8
|
import type { PluginOptions } from '@docusaurus/plugin-content-docs';
|
|
8
9
|
import type { SidebarsConfig, Sidebars, SidebarProcessorParams } from './types';
|
|
9
10
|
export declare const DefaultSidebars: SidebarsConfig;
|
package/lib/sidebars/types.d.ts
CHANGED
|
@@ -4,6 +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
|
+
/// <reference path="../../src/plugin-content-docs.d.ts" />
|
|
7
8
|
import type { Optional, Required } from 'utility-types';
|
|
8
9
|
import type { NumberPrefixParser, SidebarOptions, CategoryIndexMatcher, DocMetadataBase, VersionMetadata } from '@docusaurus/plugin-content-docs';
|
|
9
10
|
import type { Slugger } from '@docusaurus/utils';
|
package/lib/sidebars/utils.d.ts
CHANGED
|
@@ -4,6 +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
|
+
/// <reference path="../../src/plugin-content-docs.d.ts" />
|
|
7
8
|
import type { Sidebars, Sidebar, SidebarItem, SidebarItemCategory, SidebarItemLink, SidebarItemDoc, SidebarCategoriesShorthand, SidebarItemConfig, SidebarItemCategoryWithGeneratedIndex, SidebarNavigationItem } from './types';
|
|
8
9
|
import type { DocMetadataBase, PropNavigationLink, VersionMetadata } from '@docusaurus/plugin-content-docs';
|
|
9
10
|
export declare function isCategoriesShorthand(item: SidebarItemConfig): item is SidebarCategoriesShorthand;
|
package/lib/slug.d.ts
CHANGED
|
@@ -4,6 +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
|
+
/// <reference path="../src/plugin-content-docs.d.ts" />
|
|
7
8
|
import type { NumberPrefixParser, DocMetadataBase } from '@docusaurus/plugin-content-docs';
|
|
8
9
|
export default function getSlug({ baseID, frontMatterSlug, source, sourceDirName, stripDirNumberPrefixes, numberPrefixParser, }: {
|
|
9
10
|
baseID: string;
|
package/lib/tags.d.ts
CHANGED
|
@@ -4,6 +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
|
+
/// <reference path="../src/plugin-content-docs.d.ts" />
|
|
7
8
|
import type { VersionTags } from './types';
|
|
8
9
|
import type { DocMetadata } from '@docusaurus/plugin-content-docs';
|
|
9
10
|
export declare function getVersionTags(docs: DocMetadata[]): VersionTags;
|
package/lib/translations.d.ts
CHANGED
|
@@ -4,6 +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
|
+
/// <reference path="../src/plugin-content-docs.d.ts" />
|
|
7
8
|
import type { LoadedContent } from '@docusaurus/plugin-content-docs';
|
|
8
9
|
import type { TranslationFile } from '@docusaurus/types';
|
|
9
10
|
export declare function getLoadedContentTranslationFiles(loadedContent: LoadedContent): TranslationFile[];
|
package/lib/types.d.ts
CHANGED
|
@@ -4,6 +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
|
+
/// <reference path="../src/plugin-content-docs.d.ts" />
|
|
7
8
|
import type { BrokenMarkdownLink, Tag } from '@docusaurus/utils';
|
|
8
9
|
import type { VersionMetadata, LoadedVersion, CategoryGeneratedIndexMetadata } from '@docusaurus/plugin-content-docs';
|
|
9
10
|
import type { SidebarsUtils } from './sidebars/utils';
|
package/lib/versions/files.d.ts
CHANGED
|
@@ -4,6 +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
|
+
/// <reference path="../../src/plugin-content-docs.d.ts" />
|
|
7
8
|
import type { PluginOptions, VersionMetadata } from '@docusaurus/plugin-content-docs';
|
|
8
9
|
import type { VersionContext } from './index';
|
|
9
10
|
/** `[siteDir]/community_versioned_docs/version-1.0.0` */
|
package/lib/versions/index.d.ts
CHANGED
|
@@ -4,6 +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
|
+
/// <reference path="../../src/plugin-content-docs.d.ts" />
|
|
7
8
|
import type { FullVersion } from '../types';
|
|
8
9
|
import type { LoadContext } from '@docusaurus/types';
|
|
9
10
|
import type { LoadedVersion, PluginOptions, VersionBanner, VersionMetadata } from '@docusaurus/plugin-content-docs';
|
|
@@ -4,6 +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
|
+
/// <reference path="../../src/plugin-content-docs.d.ts" />
|
|
7
8
|
import type { VersionsOptions } from '@docusaurus/plugin-content-docs';
|
|
8
9
|
export declare function validateVersionName(name: unknown): asserts name is string;
|
|
9
10
|
export declare function validateVersionNames(names: unknown): asserts names is string[];
|
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-5917",
|
|
4
4
|
"description": "Docs plugin for Docusaurus.",
|
|
5
5
|
"main": "lib/index.js",
|
|
6
6
|
"sideEffects": false,
|
|
@@ -35,14 +35,14 @@
|
|
|
35
35
|
},
|
|
36
36
|
"license": "MIT",
|
|
37
37
|
"dependencies": {
|
|
38
|
-
"@docusaurus/core": "0.0.0-
|
|
39
|
-
"@docusaurus/logger": "0.0.0-
|
|
40
|
-
"@docusaurus/mdx-loader": "0.0.0-
|
|
41
|
-
"@docusaurus/module-type-aliases": "0.0.0-
|
|
42
|
-
"@docusaurus/types": "0.0.0-
|
|
43
|
-
"@docusaurus/utils": "0.0.0-
|
|
44
|
-
"@docusaurus/utils-common": "0.0.0-
|
|
45
|
-
"@docusaurus/utils-validation": "0.0.0-
|
|
38
|
+
"@docusaurus/core": "0.0.0-5917",
|
|
39
|
+
"@docusaurus/logger": "0.0.0-5917",
|
|
40
|
+
"@docusaurus/mdx-loader": "0.0.0-5917",
|
|
41
|
+
"@docusaurus/module-type-aliases": "0.0.0-5917",
|
|
42
|
+
"@docusaurus/types": "0.0.0-5917",
|
|
43
|
+
"@docusaurus/utils": "0.0.0-5917",
|
|
44
|
+
"@docusaurus/utils-common": "0.0.0-5917",
|
|
45
|
+
"@docusaurus/utils-validation": "0.0.0-5917",
|
|
46
46
|
"@types/react-router-config": "^5.0.7",
|
|
47
47
|
"combine-promises": "^1.1.0",
|
|
48
48
|
"fs-extra": "^11.1.1",
|
|
@@ -66,5 +66,5 @@
|
|
|
66
66
|
"engines": {
|
|
67
67
|
"node": ">=18.0"
|
|
68
68
|
},
|
|
69
|
-
"gitHead": "
|
|
69
|
+
"gitHead": "01a12610bcb9050a1e58d83fa4944b2ab2bca69f"
|
|
70
70
|
}
|