@docusaurus/types 2.4.1 → 3.0.0-alpha.0
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/package.json +6 -6
- package/src/config.d.ts +19 -1
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@docusaurus/types",
|
|
3
|
-
"version": "
|
|
3
|
+
"version": "3.0.0-alpha.0",
|
|
4
4
|
"description": "Common types for Docusaurus packages.",
|
|
5
5
|
"types": "./src/index.d.ts",
|
|
6
6
|
"publishConfig": {
|
|
@@ -16,15 +16,15 @@
|
|
|
16
16
|
"@types/history": "^4.7.11",
|
|
17
17
|
"@types/react": "*",
|
|
18
18
|
"commander": "^5.1.0",
|
|
19
|
-
"joi": "^17.
|
|
19
|
+
"joi": "^17.8.3",
|
|
20
20
|
"react-helmet-async": "^1.3.0",
|
|
21
21
|
"utility-types": "^3.10.0",
|
|
22
|
-
"webpack": "^5.
|
|
22
|
+
"webpack": "^5.76.0",
|
|
23
23
|
"webpack-merge": "^5.8.0"
|
|
24
24
|
},
|
|
25
25
|
"peerDependencies": {
|
|
26
|
-
"react": "^
|
|
27
|
-
"react-dom": "^
|
|
26
|
+
"react": "^18.0.0",
|
|
27
|
+
"react-dom": "^18.0.0"
|
|
28
28
|
},
|
|
29
|
-
"gitHead": "
|
|
29
|
+
"gitHead": "7327f7ff880ed97ad7855744e59c9c55d467a950"
|
|
30
30
|
}
|
package/src/config.d.ts
CHANGED
|
@@ -27,7 +27,25 @@ export type MarkdownConfig = {
|
|
|
27
27
|
* @see https://docusaurus.io/docs/markdown-features/diagrams/
|
|
28
28
|
* @default false
|
|
29
29
|
*/
|
|
30
|
-
mermaid
|
|
30
|
+
mermaid: boolean;
|
|
31
|
+
|
|
32
|
+
/**
|
|
33
|
+
* Gives opportunity to preprocess the MDX string content before compiling.
|
|
34
|
+
* A good escape hatch that can be used to handle edge cases.
|
|
35
|
+
*
|
|
36
|
+
* @param args
|
|
37
|
+
*/
|
|
38
|
+
preprocessor?: (args: {filePath: string; fileContent: string}) => string;
|
|
39
|
+
|
|
40
|
+
/**
|
|
41
|
+
* Set of flags make it easier to upgrade from MDX 1 to MDX 2
|
|
42
|
+
* See also https://github.com/facebook/docusaurus/issues/4029
|
|
43
|
+
*/
|
|
44
|
+
mdx1Compat: {
|
|
45
|
+
comments: boolean;
|
|
46
|
+
admonitions: boolean;
|
|
47
|
+
headingIds: boolean;
|
|
48
|
+
};
|
|
31
49
|
};
|
|
32
50
|
|
|
33
51
|
/**
|