Skip to content

Commit 629d75c

Browse files
committed
basic docs
1 parent 5ffce64 commit 629d75c

File tree

2 files changed

+7
-1
lines changed

2 files changed

+7
-1
lines changed

website/docs/api/docusaurus.config.js.mdx

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -186,7 +186,7 @@ It is also a way to opt-in for upcoming breaking changes coming in the next majo
186186

187187
Features prefixed by `experimental_` or `unstable_` are subject to changes in **minor versions**, and not considered as [Semantic Versioning breaking changes](/community/release-process).
188188

189-
Features prefixed by `v<MajorVersion>_` (`v6_` `v7_`, etc.) are future flags that are expected to be turned on by default in the next major versions. These are less likely to change, but we keep the possibility to do so.
189+
Features namespaced by `v<MajorVersion>` (`v6` `v7`, etc.) are future flags that are expected to be turned on by default in the next major versions. These are less likely to change, but we keep the possibility to do so.
190190

191191
`future` API breaking changes should be easy to handle, and will be documented in minor/major version blog posts.
192192

@@ -197,6 +197,9 @@ Example:
197197
```js title="docusaurus.config.js"
198198
export default {
199199
future: {
200+
v4: {
201+
removeLegacyPostBuildHeadAttribute: true,
202+
},
200203
experimental_faster: {
201204
swcJsLoader: true,
202205
swcJsMinimizer: true,
@@ -214,6 +217,8 @@ export default {
214217
};
215218
```
216219

220+
- `v4`: Permits to opt-in for upcoming Docusaurus v4 breaking changes and features, to prepare your site in advance for this new version. Use `true` as a shorthand to enable all the flags.
221+
- [`removeLegacyPostBuildHeadAttribute`](https://github.com/facebook/docusaurus/pull/10435): Removes the legacy `plugin.postBuild({head})` API that prevents us from applying useful SSG optimizations ([explanations](https://github.com/facebook/docusaurus/pull/10850)).
217222
- `experimental_faster`: An object containing feature flags to make the Docusaurus build faster. This requires adding the `@docusaurus/faster` package to your site's dependencies. Use `true` as a shorthand to enable all flags. Read more on the [Docusaurus Faster](https://github.com/facebook/docusaurus/issues/10556) issue. Available feature flags:
218223
- [`swcJsLoader`](https://github.com/facebook/docusaurus/pull/10435): Use [SWC](https://swc.rs/) to transpile JS (instead of [Babel](https://babeljs.io/)).
219224
- [`swcJsMinimizer`](https://github.com/facebook/docusaurus/pull/10441): Use [SWC](https://swc.rs/) to minify JS (instead of [Terser](https://github.com/terser/terser)).

website/docs/api/plugin-methods/lifecycle-apis.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -369,6 +369,7 @@ interface Props {
369369
preBodyTags: string;
370370
postBodyTags: string;
371371
routesPaths: string[];
372+
routesBuildMetadata: {[location: string]: {noIndex: boolean}};
372373
plugins: Plugin<any>[];
373374
content: Content;
374375
}

0 commit comments

Comments
 (0)