https://github.com/brenoepics/vitepress-carbon

Streamlined Theme for VitePress
https://github.com/brenoepics/vitepress-carbon

collaborate ghdesktop github-pages jetbrains octicons student-vscode tech typescript vitepress vitepress-plugin vitepress-theme vue

Last synced: about 1 month ago
JSON representation

Streamlined Theme for VitePress

• Host: GitHub
• URL: https://github.com/brenoepics/vitepress-carbon
• Owner: brenoepics
• License: mit
• Created: 2024-02-11T13:59:23.000Z (10 months ago)
• Default Branch: main
• Last Pushed: 2024-05-29T00:48:15.000Z (7 months ago)
• Last Synced: 2024-05-29T14:55:38.966Z (7 months ago)
• Topics: collaborate, ghdesktop, github-pages, jetbrains, octicons, student-vscode, tech, typescript, vitepress, vitepress-plugin, vitepress-theme, vue
• Language: Vue
• Homepage: https://carbon.breno.tech/
• Size: 1.66 MB
• Stars: 9
• Watchers: 1
• Forks: 3
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

• awesome-vitepress-v1 - vitepress-theme-carbon - A GitHub-like theme for Vitepress (:art: Themes / Community Themes)

README

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

![NPM Version](https://img.shields.io/npm/v/vitepress-carbon)

![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/brenoepics/vitepress-carbon/node.js.yml)

[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=brenoepics_vitepress-carbon&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=brenoepics_vitepress-carbon)

![GitHub Repo stars](https://img.shields.io/github/stars/brenoepics/vitepress-carbon)

## Demo

Check out the demo on [GitHub Pages](https://carbon.breno.tech) to see VitePress Carbon in action.

## Installation

To create a GitHub project with VitePress Carbon

theme, [click here](https://github.com/new?template_name=carbon-starter&template_owner=brenoepics).

Alternatively, you can use the [`vpcar`](https://github.com/brenoepics/vitepress-carbon/tree/main/packages/cli) CLI tool

to initialize a new VitePress Carbon project:

```sh

npx vpcar init my-project

```

## Usage

To use this project, follow these docs:

- [VitePress Carbon Docs](https://carbon.breno.tech)

- [VitePress](https://vitepress.dev/)

- [Markdown](https://www.markdownguide.org/)

## Contribution Guide

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

```sh

pnpm install

```

To start the development server, run:

```sh

pnpm run dev

```

If you encounter any issues or have suggestions for improvements, feel free

to [open an issue](https://github.com/brenoepics/vitepress-carbon/issues)

or [submit a pull request](https://github.com/brenoepics/vitepress-carbon/pulls).

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](https://github.com/brenoepics/vitepress-carbon/blob/main/LICENSE) file for details.