refactor(create-rspress): update template to match latest Rspress features and structure by SoonIter · Pull Request #3226 · web-infra-dev/rspress

SoonIter · 2026-03-13T09:57:21Z

Summary

update create-rspress template-basic to match latest Rspress features and structure
remove Rspress V2 specifier in docs
remove mdx-rs fragment

Related Issue

Checklist

Tests updated (or not required).
Documentation updated (or not required).

AI Summary

Update the create-rspress template to align with the latest Rspress documentation and features based on https://rspress.rs/llms.txt.

Changes

Replace I18n feature with AI-friendly: Updated the homepage feature card from "Simpler I18n solution" to "AI-friendly", highlighting the new llms.txt / SSG-MD capability for generating AI-native documentation. This matches the official rspress.rs homepage.
Remove Rustify MDX compiler section: Removed the incomplete and deprecated "Rustify MDX compiler" section from the guide template.
Split guide into multi-page structure: Restructured the single-page guide (guide/index.md) into a multi-page layout using "type": "dir" in _meta.json:
- guide/start/introduction.md — Rspress overview and core features
- guide/start/getting-started.md — Markdown & MDX writing guide
- Updated _nav.json and homepage links to point to the new routes

This PR was written using Vibe Kanban

Update the homepage feature card to match the official rspress.rs site, replacing "Simpler I18n solution" with "AI-friendly" highlighting the llms.txt / SSG-MD capability.

…rom template The section was incomplete and references a deprecated v1 feature.

…type: dir Restructure the template guide section from a single page into a multi-page layout matching the official Rspress site structure: - guide/start/introduction.md: Rspress overview and core features - guide/start/getting-started.md: Markdown & MDX writing guide - Use "type": "dir" in _meta.json for directory grouping - Update nav and homepage links to new routes

cloudflare-workers-and-pages · 2026-03-13T09:59:52Z

Deploying rspress-v2 with Cloudflare Pages

Latest commit:	`d40cc36`
Status:	✅ Deploy successful!
Preview URL:	https://357f9e4c.rspress-v2.pages.dev
Branch Preview URL:	https://syt-vibe-kanban-453c-https-r.rspress-v2.pages.dev

View logs

github-actions · 2026-03-13T10:00:51Z

Rsdoctor Bundle Diff Analysis

Found 3 projects in monorepo, 3 projects with changes.

📊 Quick Summary

Project	Total Size	Change
node	12.4 MB	-26.0 B (-0.0%)
node_md	1.6 MB	-54.0 B (-0.0%)
web	16.1 MB	-26.0 B (-0.0%)

📋 Detailed Reports (Click to expand)

📁 node

Path: website/doc_build/diff-rsdoctor/node/rsdoctor-data.json

📌 Baseline Commit: 0ea1fdd4ed | PR: #3232

Metric	Current	Baseline	Change
📊 Total Size	12.4 MB	12.4 MB	-26.0 B (-0.0%)
📄 JavaScript	0 B	0 B	0
🎨 CSS	0 B	0 B	0
🌐 HTML	12.4 MB	12.4 MB	-26.0 B (-0.0%)
📁 Other Assets	0 B	0 B	0

📦 Download Diff Report: node Bundle Diff

📁 node_md

Path: website/doc_build/diff-rsdoctor/node_md/rsdoctor-data.json

📌 Baseline Commit: 0ea1fdd4ed | PR: #3232

Metric	Current	Baseline	Change
📊 Total Size	1.6 MB	1.6 MB	-54.0 B (-0.0%)
📄 JavaScript	0 B	0 B	0
🎨 CSS	0 B	0 B	0
🌐 HTML	0 B	0 B	0
📁 Other Assets	1.6 MB	1.6 MB	-54.0 B (-0.0%)

📦 Download Diff Report: node_md Bundle Diff

📁 web

Path: website/doc_build/diff-rsdoctor/web/rsdoctor-data.json

📌 Baseline Commit: 0ea1fdd4ed | PR: #3232

Metric	Current	Baseline	Change
📊 Total Size	16.1 MB	16.1 MB	-26.0 B (-0.0%)
📄 JavaScript	15.9 MB	15.9 MB	-26.0 B (-0.0%)
🎨 CSS	120.3 KB	120.3 KB	0
🌐 HTML	0 B	0 B	0
📁 Other Assets	166.2 KB	166.2 KB	0

📦 Download Diff Report: web Bundle Diff

Generated by Rsdoctor GitHub Action

Copilot

Pull request overview

Updates the create-rspress basic template docs to align with the latest Rspress guidance (including AI/llms.txt positioning) and adjusts the Getting Started navigation structure.

Changes:

Update home page “Quick Start” link and replace an I18n feature highlight with an AI-friendly (llms.txt / SSG-MD) feature.
Add a new “Introduction” page under /guide/start/ and configure sidebar ordering via _meta.json.
Restructure Guide navigation metadata and update top-level nav link to point at the new introduction page.

Reviewed changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated 2 comments.

Show a summary per file

File	Description
packages/create-rspress/template-basic/docs/index.md	Updates hero Quick Start link and feature list to emphasize AI-friendly docs generation.
packages/create-rspress/template-basic/docs/guide/start/introduction.md	Adds a new introduction page for the Getting Started section.
packages/create-rspress/template-basic/docs/guide/start/_meta.json	Defines page ordering for the `/guide/start/` section.
packages/create-rspress/template-basic/docs/guide/index.md	Renames the page title and edits Markdown content, including a code-fence-related text change.
packages/create-rspress/template-basic/docs/guide/_meta.json	Changes Guide sidebar to show only the “start” directory entry.
packages/create-rspress/template-basic/docs/_nav.json	Updates the Guide navbar link to the new introduction page.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

…r and multi-page guide - Use "type": "dir-section-header" in guide/_meta.json for "Getting Started" and "Markdown & MDX" sidebar sections - Split monolithic Markdown & MDX page into use-mdx/ with separate pages: components, code-blocks, container - Rewrite getting-started.md as a proper quick start with project structure overview and dev workflow - Add link to all 6 homepage feature cards - Remove hello.md, simplify _nav.json

Copilot

Pull request overview

Updates create-rspress’s basic template docs to reflect the latest Rspress site structure/messaging (AI/SSG‑MD, multi-page guide layout), and aligns a few Shiki references across docs/fixtures.

Changes:

Refresh Shiki wording in docs/fixtures (“Rspress uses Shiki…”, removing “V2”).
Restructure the template guide into a multi-page layout (start/, use-mdx/, nested code-blocks/) with updated _meta.json / _nav.json.
Update the template homepage feature cards (add AI-friendly/SSG‑MD messaging, add links) and remove the old hello.md page.

Reviewed changes

Copilot reviewed 21 out of 21 changed files in this pull request and generated 1 comment.

Show a summary per file

File	Description
website/docs/en/guide/use-mdx/code-blocks.mdx	Removes “V2” wording in Shiki description.
website/docs/en/guide/start/introduction.mdx	Removes “V2” wording in Shiki section.
packages/create-rspress/template-basic/docs/index.md	Updates Quick Start route + refreshes feature cards (AI-friendly) and adds feature links.
packages/create-rspress/template-basic/docs/hello.md	Removes the old “Hello world” page from the template.
packages/create-rspress/template-basic/docs/guide/use-mdx/container.md	Adds container syntax guide page.
packages/create-rspress/template-basic/docs/guide/use-mdx/components.mdx	Adds MDX + built-in Tabs/Tab usage guide page.
packages/create-rspress/template-basic/docs/guide/use-mdx/code-blocks/index.mdx	Adds code blocks overview page for the new multi-page structure.
packages/create-rspress/template-basic/docs/guide/use-mdx/code-blocks/title.md	Adds a dedicated “title meta” example page.
packages/create-rspress/template-basic/docs/guide/use-mdx/code-blocks/meta.md	Adds a dedicated “meta attributes” example page.
packages/create-rspress/template-basic/docs/guide/use-mdx/code-blocks/_meta.json	Defines sidebar ordering for code-blocks subpages.
packages/create-rspress/template-basic/docs/guide/use-mdx/_meta.json	Defines sidebar structure for `use-mdx` (including nested dir).
packages/create-rspress/template-basic/docs/guide/start/introduction.md	Adds template “Introduction” guide page.
packages/create-rspress/template-basic/docs/guide/start/getting-started.md	Adds template “Getting Started” guide page and “Next steps” links.
packages/create-rspress/template-basic/docs/guide/start/_meta.json	Defines sidebar ordering for `start` section.
packages/create-rspress/template-basic/docs/guide/index.md	Removes the old single-page guide.
packages/create-rspress/template-basic/docs/guide/_meta.json	Switches to `dir-section-header` based sidebar sections.
packages/create-rspress/template-basic/docs/api/index.mdx	Adds an API overview placeholder page (overview frontmatter).
packages/create-rspress/template-basic/docs/api/commands.mdx	Adds a commands placeholder page.
packages/create-rspress/template-basic/docs/api/_meta.json	Adds sidebar ordering for API section.
packages/create-rspress/template-basic/docs/_nav.json	Updates top nav to point to new Guide route + adds local API entry + external docs link.
e2e/fixtures/ssg-md/doc/index.mdx	Removes “V2” wording in Shiki description for fixture consistency.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

Copilot

Pull request overview

Updates the create-rspress basic template documentation to reflect the current Rspress docs/features, including a new multi-page Guide structure and refreshed homepage messaging (AI/SSG-MD), while removing deprecated MDX-Rust compiler content.

Changes:

Restructures the template “Guide” into multi-page sections via _meta.json (Getting Started + Markdown/MDX).
Refreshes template homepage links/features and top nav to point at the new routes and current Rspress docs.
Removes deprecated mdxRs / “Rustify MDX compiler” fragments and references; updates wording from “Rspress V2” → “Rspress”.

Reviewed changes

Copilot reviewed 24 out of 24 changed files in this pull request and generated 4 comments.

Show a summary per file

File	Description
website/docs/zh/fragments/mdx-rs.mdx	Removes deprecated `mdxRs` fragment content (file deleted).
website/docs/en/guide/use-mdx/code-blocks.mdx	Updates wording to remove “V2” phrasing around Shiki.
website/docs/en/guide/start/introduction.mdx	Updates wording to remove “V2” phrasing around Shiki.
website/docs/en/fragments/mdx-rs.mdx	Removes deprecated `mdxRs` fragment content (file deleted).
scripts/dictionary.txt	Removes “Rustify” term from dictionary.
packages/create-rspress/template-basic/docs/index.md	Updates hero action and feature cards/links (incl. AI-friendly + SSG-MD).
packages/create-rspress/template-basic/docs/hello.md	Removes old “Hello world” page (file deleted).
packages/create-rspress/template-basic/docs/guide/use-mdx/container.md	Adds container syntax examples page.
packages/create-rspress/template-basic/docs/guide/use-mdx/components.mdx	Adds MDX + built-in component usage page.
packages/create-rspress/template-basic/docs/guide/use-mdx/code-blocks/title.md	Adds code block title example page.
packages/create-rspress/template-basic/docs/guide/use-mdx/code-blocks/meta.md	Adds code block meta example page (lineNumbers/wrapCode).
packages/create-rspress/template-basic/docs/guide/use-mdx/code-blocks/index.mdx	Adds code blocks intro page aligned with current docs.
packages/create-rspress/template-basic/docs/guide/use-mdx/code-blocks/_meta.json	Defines ordering for code-blocks sub-pages.
packages/create-rspress/template-basic/docs/guide/use-mdx/_meta.json	Defines ordering and includes code-blocks as a directory.
packages/create-rspress/template-basic/docs/guide/start/introduction.md	Adds new Getting Started introduction page.
packages/create-rspress/template-basic/docs/guide/start/getting-started.md	Adds new Getting Started instructions + next steps links.
packages/create-rspress/template-basic/docs/guide/start/_meta.json	Defines ordering for start pages.
packages/create-rspress/template-basic/docs/guide/index.md	Removes the former single-page guide (file deleted).
packages/create-rspress/template-basic/docs/guide/_meta.json	Switches sidebar to dir-section-headers for start/use-mdx sections.
packages/create-rspress/template-basic/docs/api/index.mdx	Adds an overview-enabled API landing page.
packages/create-rspress/template-basic/docs/api/commands.mdx	Adds an API commands page scaffold.
packages/create-rspress/template-basic/docs/api/_meta.json	Defines ordering for API pages.
packages/create-rspress/template-basic/docs/_nav.json	Updates top nav: Guide → new intro, replaces Hello with API, adds external “Document”.
e2e/fixtures/ssg-md/doc/index.mdx	Updates wording to remove “V2” phrasing around Shiki.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

SoonIter added 3 commits March 13, 2026 17:33

feat(create-rspress): replace I18n feature with AI-friendly in template

7de9dc1

Update the homepage feature card to match the official rspress.rs site, replacing "Simpler I18n solution" with "AI-friendly" highlighting the llms.txt / SSG-MD capability.

fix(create-rspress): remove incomplete Rustify MDX compiler section f…

e9e6703

…rom template The section was incomplete and references a deprecated v1 feature.

Copilot AI review requested due to automatic review settings March 13, 2026 09:57

SoonIter changed the title ~~根据 https://rspress.rs/llms.txt 更新一下 create-rspress 中的模版 (vibe-kanban)~~ refactor(create-rspress): update template to match latest Rspress features and structure Mar 13, 2026

Copilot AI reviewed Mar 13, 2026

View reviewed changes

Comment thread packages/create-rspress/template-basic/docs/guide/start/introduction.md

Comment thread packages/create-rspress/template-basic/docs/guide/start/introduction.md

Copilot started reviewing on behalf of SoonIter March 13, 2026 10:05 View session

SoonIter added 2 commits March 13, 2026 19:11

chore: update

9f2fabd

SoonIter requested a review from Copilot March 16, 2026 08:28

Copilot started reviewing on behalf of SoonIter March 16, 2026 08:29 View session

chore: update

2022564

Copilot AI reviewed Mar 16, 2026

View reviewed changes

Comment thread packages/create-rspress/template-basic/docs/guide/start/getting-started.md Outdated

SoonIter and others added 2 commits March 16, 2026 16:34

fix: remove rust

9c57e9c

Potential fix for pull request finding

6e88b61

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

SoonIter requested a review from Copilot March 16, 2026 11:03

Copilot started reviewing on behalf of SoonIter March 16, 2026 11:03 View session

Copilot AI reviewed Mar 16, 2026

View reviewed changes

SoonIter and others added 2 commits March 16, 2026 19:21

Apply suggestions from code review

51b655d

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

docs: remove V2 specifier

d40cc36

SoonIter requested a review from Timeless0911 March 16, 2026 11:31

SoonIter enabled auto-merge (squash) March 16, 2026 11:31

Timeless0911 approved these changes Mar 16, 2026

View reviewed changes

SoonIter merged commit 237910d into main Mar 16, 2026
6 checks passed

SoonIter deleted the syt-vibe-kanban/453c-https-rspress-rs branch March 16, 2026 12:36

SoonIter mentioned this pull request Mar 19, 2026

feat: upgrade to @rspress/core v2 web-infra-dev/rspress-codesandbox-template#1

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

refactor(create-rspress): update template to match latest Rspress features and structure#3226

refactor(create-rspress): update template to match latest Rspress features and structure#3226
SoonIter merged 10 commits intomainfrom
syt-vibe-kanban/453c-https-rspress-rs

SoonIter commented Mar 13, 2026 •

edited

Loading

Uh oh!

cloudflare-workers-and-pages Bot commented Mar 13, 2026 •

edited

Loading

Uh oh!

github-actions Bot commented Mar 13, 2026 •

edited

Loading

📁 node

📁 node_md

📁 web

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Uh oh!

Conversation

SoonIter commented Mar 13, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Related Issue

Checklist

AI Summary

Changes

Uh oh!

cloudflare-workers-and-pages Bot commented Mar 13, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Deploying rspress-v2 with Cloudflare Pages

Uh oh!

github-actions Bot commented Mar 13, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Rsdoctor Bundle Diff Analysis

📁 node

📁 node_md

📁 web

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

SoonIter commented Mar 13, 2026 •

edited

Loading

cloudflare-workers-and-pages Bot commented Mar 13, 2026 •

edited

Loading

github-actions Bot commented Mar 13, 2026 •

edited

Loading