https://github.com/brenoepics/carbon-starter
A template for VitePress Carbon Theme
https://github.com/brenoepics/carbon-starter
carbon docs documentation vitepress vitepress-carbon
Last synced: 5 months ago
JSON representation
A template for VitePress Carbon Theme
- Host: GitHub
- URL: https://github.com/brenoepics/carbon-starter
- Owner: brenoepics
- License: mit
- Created: 2024-02-19T22:06:38.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-11-10T05:03:55.000Z (over 1 year ago)
- Last Synced: 2025-08-01T10:55:11.688Z (11 months ago)
- Topics: carbon, docs, documentation, vitepress, vitepress-carbon
- Language: TypeScript
- Homepage: https://brenoepics.github.io/vitepress-carbon/
- Size: 47.9 KB
- Stars: 3
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# VitePress Carbon Template
Welcome to the [VitePress Carbon](https://github.com/brenoepics/vitepress-carbon) Template repository!
This template provides a sleek and modern documentation website built with [VitePress](https://vitepress.dev/), styled with Carbon Design System.
Whether you're documenting a project, creating a knowledge base, or writing technical guides, this template offers a clean and professional layout to showcase your content.
## Getting Started
To get started with this template, follow these simple steps:
1. Click on the **"Use this template"** button to create a new repository based on this template.
2. Clone your newly created repository to your local machine:
```bash
git clone https://github.com/your-username/your-repository.git
```
3. Navigate into the cloned repository directory:
```
cd your-repository
```
4. Install dependencies using npm or yarn:
```
npm install
# or
yarn install
```
5. Start the development server:
```
npm run docs:dev
# or
yarn run docs:dev
```
6. Open your browser and visit `http://localhost:5173` to view your documentation website.
## Available Scripts
- **`docs:dev`**: Start VitePress development server.
- **`docs:build`**: Build the documentation website for production.
- **`docs:preview`**: Preview the built documentation website.
## Contributing
If you find any issues, or you have suggestions for improvements, feel free to open an issue or submit a pull request. Contributions are welcome!
## License
This template is open-source and available under the [MIT License](LICENSE). Feel free to customize and use it for your projects.
---
Happy documenting! If you have any questions or need further assistance, don't hesitate to reach out.