docs: migrate documentation site from VitePress to Astro Starlight#123
Merged
knowledgecode merged 8 commits intomasterfrom Apr 29, 2026
Merged
docs: migrate documentation site from VitePress to Astro Starlight#123knowledgecode merged 8 commits intomasterfrom
knowledgecode merged 8 commits intomasterfrom
Conversation
- Set astro outDir to pages/ to separate build output from src - Update CI workflow to upload pages/ artifact instead of dist/ - Add custom CSS to match VitePress visual style in Starlight - Add favicon.svg and docs/tsconfig.json for Astro - Remove outdated logo.png (replaced by inline SVG or Astro asset) - Ignore .mjs and .astro in eslint; exclude docs/dist from tsconfig - Bump dev dependency versions and remove esbuild override
- Add intro paragraphs and usage examples to locales.md and timezones.md - Promote locale list items from - bullets to ### headings for TOC support - Fix homepage hero to use Astro local image asset instead of raw HTML - Fix action and API links to remove trailing slash - Replace VitePress :::tip[...] syntax with Starlight <Aside> component
Starlight automatically renders the frontmatter title as the page h1, so the explicit # Heading lines were duplicate and visually redundant.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Changes
Migration
docs/.vitepress/config.tswithastro.config.mjs(Starlight sidebar, site metadata, navigation)docs/content.config.tswith glob loader for all docs pagesdocs/public/todocs/assets/for Astro asset handlingdocs/env.d.tsfor Astro type declarationsBuild & CI
outDirtopages/(separate fromdist/) and update CI workflow upload path accordinglypages/to.gitignorepackage.jsonscripts, devDependencies, and removeesbuildoverrideeslint.config.jsto ignore.mjs/.astrofiles; fixtsconfig.jsonto excludedocs/anddist/Docs content
docs/index.md→docs/index.mdx(Starlight splash template with hero)docs/guide/installation.md→docs/guide/installation.mdx(Tabs component + Aside)locales.mdandtimezones.mddocs/styles/custom.cssto replicate VitePress heading scale, accent colors, table styles, and paginationdocs/tsconfig.jsonfor Astro's type resolution# h1headings from all docs pages (Starlight renders the frontmattertitleas h1 automatically)Test plan
npm run docs:dev— verify local dev server starts and renders pages correctlynpm run docs:build— verify build succeeds and outputs topages/pages/artifact on push to master