Re-enable gfm for Astro docs#2308
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
2 Skipped Deployments
|
|
📝 WalkthroughWalkthroughEnables GitHub Flavored Markdown ( ChangesSchema Docs Reformatting
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Suggested labels
Poem
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Pull request overview
This PR updates the docs site configuration to explicitly enable GitHub Flavored Markdown (GFM) to avoid a breaking behavior change in astro@6.4.4, and restructures headings on the ENS Unigraph schema reference page to improve navigation and document hierarchy.
Changes:
- Explicitly enable
markdown.gfmin the Astro docs site config to preserve expected Markdown parsing behavior. - Convert inline/bold “section titles” on the schema reference page into proper
###/####headings and group tables under a new “Tables” section.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| docs/ensnode.io/astro.config.mjs | Enables markdown.gfm: true to stabilize Markdown behavior across Astro versions. |
| docs/ensnode.io/src/content/docs/docs/integrate/unigraph/schema-reference.mdx | Improves document structure by promoting enum/table labels and index labels to real headings. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Greptile SummaryThis PR upgrades three Astro ecosystem packages (
Confidence Score: 5/5Safe to merge — all changes are confined to the docs package, with no impact on application logic or data handling. The changes are dependency upgrades within the docs site and a documentation restructuring. The upgrades follow the upstream fix for a known Astro regression and the lockfile is consistent with the new specifiers. The only noteworthy detail is that starlight-llms-txt still resolves a copy of the old @astrojs/mdx, but this does not affect the main docs build or any application code. The pnpm-lock.yaml dual @astrojs/mdx install (5.0.6 via starlight-llms-txt + 6.0.3 directly) is worth a quick look, but does not block the merge. Important Files Changed
Flowchart%%{init: {'theme': 'neutral'}}%%
flowchart TD
A["astro@6.4.4+\n(GFM regression)"] -->|"broke"| B["@astrojs/mdx@5.x\n(GFM disabled)"]
B -->|"fixed by upgrading to"| C["@astrojs/mdx@6.0.3\n(remark-gfm re-enabled)"]
C --> D["@astrojs/starlight@0.40.0"]
D --> E["starlight-sidebar-topics@0.8.0"]
D --> F["astro-expressive-code@0.43.1"]
D --> G["pagefind@1.5.2"]
H["starlight-llms-txt@0.10.0"] -->|"still pins (old)"| B2["@astrojs/mdx@5.0.6\n⚠️ both versions installed"]
H --> D
style B fill:#f99,stroke:#c00
style C fill:#9f9,stroke:#090
style B2 fill:#ff9,stroke:#990
%%{init: {'theme': 'base', 'themeVariables': {"darkMode": true, "background": "#0d1117", "primaryColor": "#21262d", "primaryTextColor": "#e6edf3", "primaryBorderColor": "#8b949e", "lineColor": "#8b949e", "textColor": "#e6edf3", "edgeLabelBackground": "#161b22", "actorBkg": "#21262d", "actorBorder": "#8b949e", "actorTextColor": "#e6edf3", "actorLineColor": "#8b949e", "signalColor": "#8b949e", "signalTextColor": "#e6edf3", "noteBkgColor": "#373320", "noteBorderColor": "#d4a72c", "noteTextColor": "#f0e6c0", "labelBoxBkgColor": "#21262d", "labelBoxBorderColor": "#8b949e", "labelTextColor": "#e6edf3", "loopTextColor": "#e6edf3", "activationBkgColor": "#30363d", "activationBorderColor": "#8b949e"}}}%%
flowchart TD
A["astro@6.4.4+\n(GFM regression)"] -->|"broke"| B["@astrojs/mdx@5.x\n(GFM disabled)"]
B -->|"fixed by upgrading to"| C["@astrojs/mdx@6.0.3\n(remark-gfm re-enabled)"]
C --> D["@astrojs/starlight@0.40.0"]
D --> E["starlight-sidebar-topics@0.8.0"]
D --> F["astro-expressive-code@0.43.1"]
D --> G["pagefind@1.5.2"]
H["starlight-llms-txt@0.10.0"] -->|"still pins (old)"| B2["@astrojs/mdx@5.0.6\n⚠️ both versions installed"]
H --> D
style B fill:#f99,stroke:#c00
style C fill:#9f9,stroke:#090
style B2 fill:#ff9,stroke:#990
Reviews (3): Last reviewed commit: "Explicitly enable `gfm` option in Astro...." | Re-trigger Greptile |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/ensnode.io/astro.config.mjs`:
- Around line 35-37: The markdown.gfm configuration in astro.config.mjs is using
a deprecated approach from Astro 6.4.0. To future-proof the configuration for
Astro 8.0 compatibility, migrate the gfm option from being a direct property of
the markdown object to being nested under a processor object. Move the gfm: true
setting so it becomes markdown.processor.gfm instead of markdown.gfm, updating
the configuration structure accordingly.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: ASSERTIVE
Plan: Pro
Run ID: 4b2efd38-2910-4c94-aee7-97e863a4e8d0
📒 Files selected for processing (2)
docs/ensnode.io/astro.config.mjsdocs/ensnode.io/src/content/docs/docs/integrate/unigraph/schema-reference.mdx
tk-o
force-pushed
the
fix/github-flavoured-markdown-for-astro
branch
from
5c6b979 to
79e2ed6
Compare
tk-o
changed the title
gfm option in Astro.js configgfm for Astro docs
|
@greptile review |
This PR addresses a breaking change introduced in
astro@6.4.4:6.4.4,markdown.gfmneeds to be explicitly set totruewithastro/astro#16971The actual fix was to upgrade
@astrojs/mdxand@astrojs/starlightdependencies, which re-enabled thegfs(github-flavoured markdown) option.Also, this PR improves header structure on the schema reference page for ENS Unigraph.