arbonVitePress Carbon is a minimalistic theme for VitePress, inspired by GitHub's monochromatic design. It offers a clean and elegant documentation experience, ideal for projects seeking simplicity.
Check out the demo on GitHub Pages to see VitePress Carbon in action.
Every theme component, rendered in isolation, lives at
carbon.breno.tech/storybook — including
an Overflow section that stress-tests components with oversized text. Run it
locally with pnpm storybook.
To create a GitHub project with VitePress Carbon theme, click here.
Alternatively, you can use the vpcar CLI tool
to initialize a new VitePress Carbon project:
npx vpcar init my-projectTo use this project, follow these docs:
Carbon has a documented design language — color roles, typography, spacing, shape,
and elevation, with light and dark values for every token. Read
design.md before changing any UI, and build with the --vp-* tokens
in packages/theme/src/theme/styles/vars.css
rather than hardcoded values.
Before contributing, read AGENTS.md — the setup, commands, conventions, and workflow that apply to human and automated contributors alike.
We use pnpm as our package manager. To get started, run:
pnpm installTo start the development server, run:
pnpm run devIf you encounter any issues or have suggestions for improvements, feel free to open an issue or submit a pull request. Your contributions and ⭐ are greatly appreciated!
This monorepo contains the following packages:
theme: The theme package for VitePress.cli: CLI tool for initializing and managing VitePress Carbon projects.demo: Demo project showcasing the VitePress Carbon theme.storybook: Component workbench, deployed alongside the demo at/storybook/.
This project is licensed under the MIT License - see the LICENSE file for details.