Skip to content

[WIP] Introduce xmdx #13274

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
jp-knj wants to merge 3 commits into
base: main
Choose a base branch
from
+1,056 −208
Draft

[WIP] Introduce xmdx #13274

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3cf3674
feat: install xmdx and setup config
jp-knj Mar 7, 2026
364190f
chore: bump astro-xmdx to 0.0.10-next.6
jp-knj Mar 8, 2026
e89af93
install xmdx
jp-knj Mar 8, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 8 additions & 4 deletions astro.config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
import starlight from '@astrojs/starlight';
import { pluginCollapsibleSections } from '@expressive-code/plugin-collapsible-sections';
import xmdx from 'astro-xmdx';
import { starlightPreset } from 'astro-xmdx/presets';
import { defineConfig, sharpImageService } from 'astro/config';
import rehypeSlug from 'rehype-slug';
import remarkSmartypants from 'remark-smartypants';
Expand Down Expand Up @@ -28,9 +29,6 @@ export default defineConfig({
]),
starlight({
title: 'Docs',
expressiveCode: {
plugins: [pluginCollapsibleSections()],
},
components: {
EditLink: './src/components/starlight/EditLink.astro',
Hero: './src/components/starlight/Hero.astro',
Expand Down Expand Up @@ -72,6 +70,7 @@ export default defineConfig({
plugins: [starlightPluginSmokeTest(), starlightPluginLlmsTxt()],
}),
sitemap(),
xmdx({ presets: [starlightPreset()] }),
],
trailingSlash: 'always',
scopedStyleStrategy: 'where',
Expand All @@ -95,4 +94,9 @@ export default defineConfig({
domains: ['avatars.githubusercontent.com'],
service: sharpImageService(),
},
vite: {
ssr: {
noExternal: ['xmdx'],
},
},
});
2 changes: 2 additions & 0 deletions config/plugins/llms-txt.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,4 +113,6 @@ export const starlightPluginLlmsTxt = () =>
'en/guides/testing',
'en/guides/media/**',
],
// Use raw Markdown bodies to avoid rendering issues.
rawContent: true,
});
9 changes: 6 additions & 3 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,15 +59,17 @@
"dependencies": {
"@astrojs/check": "^0.9.6",
"@astrojs/sitemap": "^3.6.0",
"@astrojs/starlight": "^0.37.1",
"@astrojs/starlight": "https://pkg.pr.new/@astrojs/starlight@5173976",
"@expressive-code/plugin-collapsible-sections": "^0.41.3",
"@lunariajs/core": "https://pkg.pr.new/lunariajs/lunaria/@lunariajs/core@722c34c",
"astro-xmdx": "0.0.10-next.7",
"canvas-confetti": "^1.6.0",
"jsdoc-api": "^9.3.5",
"rehype-slug": "^6.0.0",
"remark-smartypants": "^3.0.2",
"sharp": "^0.34.3",
"starlight-llms-txt": "^0.6.0"
"starlight-llms-txt": "^0.6.0",
"xmdx": "0.0.9-next.1"
},
"packageManager": "pnpm@10.27.0",
"pnpm": {
Expand All @@ -78,6 +80,7 @@
"react-dom",
"vite"
]
}
},
"overrides": {}
}
}
Loading
Loading