Deliver a crisp, reliable reading experience with layouts that stay balanced from phones to ultra-wide displays.
VitePress Carbon
Streamlined Theme
GitHub-inspired docs with sharper contrast, balanced spacing, and a polished feel on every screen.
Skip to content 
Get started
Install it, point your config at it, done
Carbon is a drop-in VitePress theme. There is no build step to wire up and no configuration to port — your existing config.mts keeps working.
sh
npm install vitepress-carbonsh
pnpm add vitepress-carbonsh
yarn add vitepress-carbonsh
bun add vitepress-carbonjs
// .vitepress/theme/index.js
import { VPCarbon } from 'vitepress-carbon'
export default VPCarbonWhy Carbon
Docs your readers already know how to use
Your README already fits
Paste it in and it renders exactly as it does on GitHub — same headings, tables, code and callouts. Nothing to reformat, nothing to double‑check.
A dark mode you won't apologise for
Both schemes are drawn from Primer's own tokens, so neither is an inverted afterthought. Ship on day one without a contrast audit.
Zero orientation required
Grouped sidebar, an outline that follows your scroll, keyboard search. Anyone who uses GitHub daily already knows where everything is.
Restyle it without forking it
Every surface, accent and radius is a CSS variable. Make it yours by changing a token — not by fighting specificity in someone else's component.
Thank you
Built by these people
Every kind of contribution counts here — commits, pull requests, issues, reviews and comments all earn a place on this wall.
brenoepics271 commits, 31 pull requests, 5 issues, 5 reviews, 33 comments
marlonwq15 commits, 5 pull requests, 2 reviews, 6 comments
RomainMazB2 commits, 2 pull requests, 3 issues, 2 comments
gabriel-logan3 reviews
MatheusVSN1 commit, 1 pull request
otabekoff1 issue, 1 comment
shubham75221 comment
theaddonn1 issue
Read the guide
Full setup, configuration and theming reference — including how to extend Carbon without forking it.