arbon

VitePress 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.

Demo

Check out the demo on GitHub Pages to see VitePress Carbon in action.

Installation

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-project

Usage

To use this project, follow these docs:

• VitePress Carbon Docs
• VitePress
• Markdown

Contribution Guide

We use pnpm as our package manager. To get started, run:

pnpm install

To start the development server, run:

pnpm run dev

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!

Packages

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.

License

This project is licensed under the MIT License - see the LICENSE file for details.