Skip to content

Commit 9bcb1f8

Browse files
authored
fix(build): make docs build work with Docusaurus 3.10 (#77)
Docusaurus 3.10 requires `@docusaurus/faster` to be declared as an explicit dependency whenever `future.v4` is enabled, and it also flips `mdx1CompatDisabledByDefault` to `true`, which dropped support for HTML comments in `.md` files. Add `@docusaurus/faster` to the dependencies, and move the `markdown` config to the top level of `Config` with the real `mdx1Compat` keys (`comments`, `admonitions`, `headingIds`). The previous block was nested inside `themeConfig` and used non-existent keys, so it had always been a no-op; it only happened to work on 3.9 because the defaults matched. Closes #76 Signed-off-by: Marco Nenciarini <marco.nenciarini@enterprisedb.com>
1 parent 419b245 commit 9bcb1f8

3 files changed

Lines changed: 475 additions & 11 deletions

File tree

website/docusaurus.config.ts

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -182,21 +182,22 @@ const config: Config = {
182182
<a href="https://www.postgresql.org/about/policies/trademarks">Postgres, PostgreSQL and the Slonik Logo are
183183
trademarks or registered trademarks of the PostgreSQL Community Association of Canada, and
184184
used with their permission</a>.`
185-
},
186-
markdown: {
187-
mdx1Compat: {
188-
allowComments: true,
189-
allowHtml: true,
190-
},
191-
hooks: {
192-
onBrokenMarkdownLinks: 'throw',
193-
},
194185
},
195186
prism: {
196187
theme: prismThemes.github,
197188
darkTheme: prismThemes.dracula,
198189
},
199190
} satisfies Preset.ThemeConfig,
191+
markdown: {
192+
mdx1Compat: {
193+
comments: true,
194+
admonitions: true,
195+
headingIds: true,
196+
},
197+
hooks: {
198+
onBrokenMarkdownLinks: 'throw',
199+
},
200+
},
200201
plugins: [
201202
[
202203
'@docusaurus/plugin-client-redirects',

website/package.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@
1616
},
1717
"dependencies": {
1818
"@docusaurus/core": "3.10.0",
19+
"@docusaurus/faster": "3.10.0",
1920
"@docusaurus/plugin-client-redirects": "3.10.0",
2021
"@docusaurus/preset-classic": "3.10.0",
2122
"@easyops-cn/docusaurus-search-local": "^0.55.0",

0 commit comments

Comments
 (0)