docusaurus-plugin-typedoc 1.0.0-next.11 → 1.0.0-next.12
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/README.md +7 -9
- package/package.json +5 -3
package/README.md
CHANGED
|
@@ -93,7 +93,6 @@ The following typedoc-plugin-markdown options are preset with the plugin.
|
|
|
93
93
|
"hideBreadcrumbs": true,
|
|
94
94
|
"hidePageHeader": true,
|
|
95
95
|
"entryFileName": "index.md",
|
|
96
|
-
"globalsPageStrategy": "skip",
|
|
97
96
|
"includeFileNumberPrefixes": true
|
|
98
97
|
}
|
|
99
98
|
```
|
|
@@ -106,15 +105,19 @@ Options specific to the plugin should also be declared in the same object.
|
|
|
106
105
|
|
|
107
106
|
`sidebar.autoConfiguration`
|
|
108
107
|
|
|
109
|
-
Set to `false` to disable sidebar
|
|
108
|
+
Set to `false` to disable sidebar metadata added to frontmatter. Defaults to `true`.
|
|
110
109
|
|
|
111
110
|
`sidebar.categoryLabel`
|
|
112
111
|
|
|
113
|
-
The sidebar main parent category label. Defaults to
|
|
112
|
+
The sidebar main parent category label. Defaults to entry page title.
|
|
113
|
+
|
|
114
|
+
`sidebar.readmeLabel`
|
|
115
|
+
|
|
116
|
+
The label of the readme page. Defaults to the h1 title of the readme page. Ignored if `readme=none`.
|
|
114
117
|
|
|
115
118
|
`sidebar.indexLabel`
|
|
116
119
|
|
|
117
|
-
The label of the
|
|
120
|
+
The label of the index page. Defaults to the index page title.
|
|
118
121
|
|
|
119
122
|
`sidebar.position`
|
|
120
123
|
|
|
@@ -143,11 +146,6 @@ module.exports = {
|
|
|
143
146
|
|
|
144
147
|
// Plugin options
|
|
145
148
|
out: 'api-xyz',
|
|
146
|
-
sidebar: {
|
|
147
|
-
categoryLabel: 'API XYZ',
|
|
148
|
-
position: 0,
|
|
149
|
-
fullNames: true,
|
|
150
|
-
},
|
|
151
149
|
},
|
|
152
150
|
],
|
|
153
151
|
],
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "docusaurus-plugin-typedoc",
|
|
3
|
-
"version": "1.0.0-next.
|
|
3
|
+
"version": "1.0.0-next.12",
|
|
4
4
|
"description": "A Docusaurus v2 plugin to build API documentation with TypeDoc.",
|
|
5
5
|
"main": "dist/index.js",
|
|
6
6
|
"files": [
|
|
@@ -15,10 +15,12 @@
|
|
|
15
15
|
"directory": "packages/docusaurus-plugin-typedoc"
|
|
16
16
|
},
|
|
17
17
|
"homepage": "https://github.com/tgreyuk/typedoc-plugin-markdown/tree/master/packages/docusaurus-plugin-typedoc",
|
|
18
|
-
"
|
|
19
|
-
"typedoc-plugin-markdown": ">=4.0.0-next.13",
|
|
18
|
+
"dependencies": {
|
|
20
19
|
"typedoc-plugin-frontmatter": ">=0.0.2"
|
|
21
20
|
},
|
|
21
|
+
"peerDependencies": {
|
|
22
|
+
"typedoc-plugin-markdown": ">=4.0.0-next.13"
|
|
23
|
+
},
|
|
22
24
|
"scripts": {
|
|
23
25
|
"lint": "eslint ./src --ext .ts",
|
|
24
26
|
"prepublishOnly": "npm run lint && npm run build",
|