Enable Docusaurus future flags to prepare for v4#3403
Conversation
Test Results 5 files ± 0 209 suites ±0 45m 12s ⏱️ - 2h 37m 46s Results for commit 8d1fac3. ± Comparison against base commit e0e38d6. This pull request removes 76 tests.♻️ This comment has been updated with latest results. |
There was a problem hiding this comment.
Sadly there's two issues:
- enabling
useCssCascadeLayersjust broke the website design except on the home page (see animation) - Admonitions with a custom title are broken (visible at the bottom of the animation, it now show "::note Note")
For 1. it's a limitation with the redesign (#2597) as it straight copied some docusaurus components, meaning that to update them for useCssCascadeLayers we basically have to redo the design.
Here's what the designer answered to that concern:
When upgrading to docusaurus 4 you may indeed need to stash the changed theme components and manually check what/where to change so that you get the same nav and footer component as right now - it may end up being a simple swap in depending on what components are reworked.
Though with it they appear to be shifting away from their .css file and moving to infima so a revision of the docs site will be required regardless of the theme directory components.
We may look into it, but I think that task will be difficult without a designer.
For 2. the fix is simple, the custom title must be surround by brackets, e.g.:
-:::info Update 2024/10/02
+:::info[Update 2024/10/02]This have to be applied to all admonitions with a custom title (which can be found by tracking :::).
|
thanks @Alenar. I'll take a look and try to fix it. |
f6f8e42 to
379586f
Compare
There was a problem hiding this comment.
Pull request overview
This PR prepares the documentation website for an eventual Docusaurus v4 upgrade by enabling v4 future flags, migrating deprecated config, and adjusting docs/CSS to match updated parsing and styling behavior.
Changes:
- Enabled Docusaurus v4 future flags and migrated
onBrokenMarkdownLinksintomarkdown.hooks. - Updated admonition syntax and list formatting in multiple docs/blog posts for MDX/Docusaurus compatibility.
- Added/adjusted CSS overrides to fix styling regressions (notably Tailwind preflight vs Infima interactions) and restore expected hover behavior.
Reviewed changes
Copilot reviewed 17 out of 17 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| docs/website/docusaurus.config.js | Enables Docusaurus v4 future flags and migrates broken-markdown-link handling to markdown.hooks. |
| docs/website/src/css/custom.css | Adds hover styles and multiple Infima override rules to resolve styling conflicts under future flags. |
| docs/website/root/mithril/advanced/threat-model.md | Updates admonition title syntax and minor formatting for compatibility. |
| docs/website/versioned_docs/version-maintained/mithril/advanced/threat-model.md | Same admonition/formatting adjustments for the maintained doc version. |
| docs/website/root/mithril/advanced/mithril-protocol/protocol.md | Updates admonition syntax and list formatting for compatibility. |
| docs/website/versioned_docs/version-maintained/mithril/advanced/mithril-protocol/protocol.md | Same admonition/formatting adjustments for the maintained doc version. |
| docs/website/versioned_docs/version-maintained/mithril/advanced/mithril-protocol/certificates.md | Updates admonition syntax for compatibility. |
| docs/website/root/manual/operate/run-signer-node.md | Adds spacing/formatting tweaks for stable rendering with new markdown behavior. |
| docs/website/versioned_docs/version-maintained/manual/operate/run-signer-node.md | Same formatting tweaks for the maintained doc version. |
| docs/website/root/manual/operate/run-aggregator-node.md | Adds spacing/formatting tweaks for stable rendering with new markdown behavior. |
| docs/website/versioned_docs/version-maintained/manual/operate/run-aggregator-node.md | Same formatting tweaks for the maintained doc version. |
| docs/website/blog/2026-01-06-multiple-aggregators-testing-program.md | Updates admonition title syntax for compatibility. |
| docs/website/blog/2026-01-06-dmq-testing-program.md | Updates admonition title syntax for compatibility. |
| docs/website/blog/2025-11-03-distribution-2543.md | Updates admonition title syntax for compatibility. |
| docs/website/blog/2025-06-17-client-cli-cardano-database-backends.md | Adds spacing/formatting tweaks for stable rendering. |
| docs/website/blog/2024-12-17-era-switch-pythagoras.md | Adds spacing/formatting tweaks for stable rendering. |
| docs/website/blog/2022-10-11-keys-certification-badge/index.md | Adds spacing/formatting tweaks for stable rendering. |
0605f61 to
9b7b75b
Compare





Content
Pre-submit checklist
N/A - minor change
Comments
My first PR, so let me know if any additional formatting required.
Issue(s)
Related to draft https://github.com/orgs/input-output-hk/projects/26/views/14?pane=issue&itemId=119928726