@docusaurus/preset-classic 2.0.0-beta.16 → 2.0.0-beta.19
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/index.d.ts +2 -1
- package/lib/options.d.ts +44 -0
- package/lib/options.js +8 -0
- package/package.json +14 -14
- package/src/index.ts +3 -1
- package/src/{preset-classic.d.ts → options.ts} +17 -0
package/lib/index.d.ts
CHANGED
|
@@ -5,5 +5,6 @@
|
|
|
5
5
|
* LICENSE file in the root directory of this source tree.
|
|
6
6
|
*/
|
|
7
7
|
import type { Preset, LoadContext } from '@docusaurus/types';
|
|
8
|
-
import type { Options } from '
|
|
8
|
+
import type { Options, ThemeConfig } from './options';
|
|
9
9
|
export default function preset(context: LoadContext, opts?: Options): Preset;
|
|
10
|
+
export type { Options, ThemeConfig };
|
package/lib/options.d.ts
ADDED
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Copyright (c) Facebook, Inc. and its affiliates.
|
|
3
|
+
*
|
|
4
|
+
* This source code is licensed under the MIT license found in the
|
|
5
|
+
* LICENSE file in the root directory of this source tree.
|
|
6
|
+
*/
|
|
7
|
+
import type { Options as DocsPluginOptions } from '@docusaurus/plugin-content-docs';
|
|
8
|
+
import type { Options as BlogPluginOptions } from '@docusaurus/plugin-content-blog';
|
|
9
|
+
import type { Options as PagesPluginOptions } from '@docusaurus/plugin-content-pages';
|
|
10
|
+
import type { Options as SitemapPluginOptions } from '@docusaurus/plugin-sitemap';
|
|
11
|
+
import type { Options as GAPluginOptions } from '@docusaurus/plugin-google-analytics';
|
|
12
|
+
import type { Options as GtagPluginOptions } from '@docusaurus/plugin-google-gtag';
|
|
13
|
+
import type { Options as ThemeOptions } from '@docusaurus/theme-classic';
|
|
14
|
+
import type { ThemeConfig as BaseThemeConfig } from '@docusaurus/types';
|
|
15
|
+
import type { UserThemeConfig as ClassicThemeConfig } from '@docusaurus/theme-common';
|
|
16
|
+
import type { UserThemeConfig as AlgoliaThemeConfig } from '@docusaurus/theme-search-algolia';
|
|
17
|
+
export declare type Options = {
|
|
18
|
+
/**
|
|
19
|
+
* Options for `@docusaurus/plugin-debug`. Use `false` to disable, or `true`
|
|
20
|
+
* to enable even in production.
|
|
21
|
+
*/
|
|
22
|
+
debug?: boolean;
|
|
23
|
+
/** Options for `@docusaurus/plugin-content-docs`. Use `false` to disable. */
|
|
24
|
+
docs?: false | DocsPluginOptions;
|
|
25
|
+
/** Options for `@docusaurus/plugin-content-blog`. Use `false` to disable. */
|
|
26
|
+
blog?: false | BlogPluginOptions;
|
|
27
|
+
/** Options for `@docusaurus/plugin-content-pages`. Use `false` to disable. */
|
|
28
|
+
pages?: false | PagesPluginOptions;
|
|
29
|
+
/** Options for `@docusaurus/plugin-sitemap`. Use `false` to disable. */
|
|
30
|
+
sitemap?: false | SitemapPluginOptions;
|
|
31
|
+
/** Options for `@docusaurus/theme-classic`. */
|
|
32
|
+
theme?: ThemeOptions;
|
|
33
|
+
/**
|
|
34
|
+
* Options for `@docusaurus/plugin-google-analytics`. Only enabled when the
|
|
35
|
+
* key is present.
|
|
36
|
+
*/
|
|
37
|
+
googleAnalytics?: GAPluginOptions;
|
|
38
|
+
/**
|
|
39
|
+
* Options for `@docusaurus/plugin-google-gtag`. Only enabled when the key
|
|
40
|
+
* is present.
|
|
41
|
+
*/
|
|
42
|
+
gtag?: GtagPluginOptions;
|
|
43
|
+
};
|
|
44
|
+
export declare type ThemeConfig = BaseThemeConfig & ClassicThemeConfig & AlgoliaThemeConfig;
|
package/lib/options.js
ADDED
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/**
|
|
3
|
+
* Copyright (c) Facebook, Inc. and its affiliates.
|
|
4
|
+
*
|
|
5
|
+
* This source code is licensed under the MIT license found in the
|
|
6
|
+
* LICENSE file in the root directory of this source tree.
|
|
7
|
+
*/
|
|
8
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
package/package.json
CHANGED
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@docusaurus/preset-classic",
|
|
3
|
-
"version": "2.0.0-beta.
|
|
3
|
+
"version": "2.0.0-beta.19",
|
|
4
4
|
"description": "Classic preset for Docusaurus.",
|
|
5
5
|
"main": "lib/index.js",
|
|
6
|
-
"types": "
|
|
6
|
+
"types": "lib/index.d.ts",
|
|
7
7
|
"scripts": {
|
|
8
8
|
"build": "tsc",
|
|
9
9
|
"watch": "tsc --watch"
|
|
@@ -18,17 +18,17 @@
|
|
|
18
18
|
},
|
|
19
19
|
"license": "MIT",
|
|
20
20
|
"dependencies": {
|
|
21
|
-
"@docusaurus/core": "2.0.0-beta.
|
|
22
|
-
"@docusaurus/plugin-content-blog": "2.0.0-beta.
|
|
23
|
-
"@docusaurus/plugin-content-docs": "2.0.0-beta.
|
|
24
|
-
"@docusaurus/plugin-content-pages": "2.0.0-beta.
|
|
25
|
-
"@docusaurus/plugin-debug": "2.0.0-beta.
|
|
26
|
-
"@docusaurus/plugin-google-analytics": "2.0.0-beta.
|
|
27
|
-
"@docusaurus/plugin-google-gtag": "2.0.0-beta.
|
|
28
|
-
"@docusaurus/plugin-sitemap": "2.0.0-beta.
|
|
29
|
-
"@docusaurus/theme-classic": "2.0.0-beta.
|
|
30
|
-
"@docusaurus/theme-common": "2.0.0-beta.
|
|
31
|
-
"@docusaurus/theme-search-algolia": "2.0.0-beta.
|
|
21
|
+
"@docusaurus/core": "2.0.0-beta.19",
|
|
22
|
+
"@docusaurus/plugin-content-blog": "2.0.0-beta.19",
|
|
23
|
+
"@docusaurus/plugin-content-docs": "2.0.0-beta.19",
|
|
24
|
+
"@docusaurus/plugin-content-pages": "2.0.0-beta.19",
|
|
25
|
+
"@docusaurus/plugin-debug": "2.0.0-beta.19",
|
|
26
|
+
"@docusaurus/plugin-google-analytics": "2.0.0-beta.19",
|
|
27
|
+
"@docusaurus/plugin-google-gtag": "2.0.0-beta.19",
|
|
28
|
+
"@docusaurus/plugin-sitemap": "2.0.0-beta.19",
|
|
29
|
+
"@docusaurus/theme-classic": "2.0.0-beta.19",
|
|
30
|
+
"@docusaurus/theme-common": "2.0.0-beta.19",
|
|
31
|
+
"@docusaurus/theme-search-algolia": "2.0.0-beta.19"
|
|
32
32
|
},
|
|
33
33
|
"peerDependencies": {
|
|
34
34
|
"react": "^16.8.4 || ^17.0.0",
|
|
@@ -37,5 +37,5 @@
|
|
|
37
37
|
"engines": {
|
|
38
38
|
"node": ">=14"
|
|
39
39
|
},
|
|
40
|
-
"gitHead": "
|
|
40
|
+
"gitHead": "a71e60a49cce93c1006ef10c41ac03187f057102"
|
|
41
41
|
}
|
package/src/index.ts
CHANGED
|
@@ -11,7 +11,7 @@ import type {
|
|
|
11
11
|
PluginConfig,
|
|
12
12
|
PluginOptions,
|
|
13
13
|
} from '@docusaurus/types';
|
|
14
|
-
import type {Options, ThemeConfig} from '
|
|
14
|
+
import type {Options, ThemeConfig} from './options';
|
|
15
15
|
|
|
16
16
|
function makePluginConfig(
|
|
17
17
|
source: string,
|
|
@@ -93,3 +93,5 @@ export default function preset(
|
|
|
93
93
|
|
|
94
94
|
return {themes, plugins};
|
|
95
95
|
}
|
|
96
|
+
|
|
97
|
+
export type {Options, ThemeConfig};
|
|
@@ -17,13 +17,30 @@ import type {UserThemeConfig as ClassicThemeConfig} from '@docusaurus/theme-comm
|
|
|
17
17
|
import type {UserThemeConfig as AlgoliaThemeConfig} from '@docusaurus/theme-search-algolia';
|
|
18
18
|
|
|
19
19
|
export type Options = {
|
|
20
|
+
/**
|
|
21
|
+
* Options for `@docusaurus/plugin-debug`. Use `false` to disable, or `true`
|
|
22
|
+
* to enable even in production.
|
|
23
|
+
*/
|
|
20
24
|
debug?: boolean;
|
|
25
|
+
/** Options for `@docusaurus/plugin-content-docs`. Use `false` to disable. */
|
|
21
26
|
docs?: false | DocsPluginOptions;
|
|
27
|
+
/** Options for `@docusaurus/plugin-content-blog`. Use `false` to disable. */
|
|
22
28
|
blog?: false | BlogPluginOptions;
|
|
29
|
+
/** Options for `@docusaurus/plugin-content-pages`. Use `false` to disable. */
|
|
23
30
|
pages?: false | PagesPluginOptions;
|
|
31
|
+
/** Options for `@docusaurus/plugin-sitemap`. Use `false` to disable. */
|
|
24
32
|
sitemap?: false | SitemapPluginOptions;
|
|
33
|
+
/** Options for `@docusaurus/theme-classic`. */
|
|
25
34
|
theme?: ThemeOptions;
|
|
35
|
+
/**
|
|
36
|
+
* Options for `@docusaurus/plugin-google-analytics`. Only enabled when the
|
|
37
|
+
* key is present.
|
|
38
|
+
*/
|
|
26
39
|
googleAnalytics?: GAPluginOptions;
|
|
40
|
+
/**
|
|
41
|
+
* Options for `@docusaurus/plugin-google-gtag`. Only enabled when the key
|
|
42
|
+
* is present.
|
|
43
|
+
*/
|
|
27
44
|
gtag?: GtagPluginOptions;
|
|
28
45
|
};
|
|
29
46
|
|