Skip to content
On this page

Last updated:

VitePress Carbon

VitePress Carbon is a sleek and minimalistic theme for VitePress, inspired by GitHub's monochromatic design ethos. With its clean and elegant style, VitePress Carbon offers a seamless documentation experience, perfect for projects seeking simplicity and sophistication.

Try it online

Check out the StackBlitz demo to see VitePress Carbon in action.

Installation

To create a project with VitePress Carbon theme, you have three options:

  1. Create a new project using the template: click here.

  2. Use the vpcar CLI tool to initialize a new VitePress Carbon project:

    sh
     npx vpcar init my-project
    sh
     pnpm dlx vpcar init my-project
    sh
     yarn dlx vpcar init my-project
    sh
     bun x vpcar init my-project
  3. Add VitePress Carbon to an existing VitePress project: Follow the Getting Started guide.

Contribution Guidelines

If 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!