Welcome to the VitePress Carbon Template repository! This template provides a sleek and modern documentation website built with VitePress, 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.
To get started with this template, follow these simple steps:
-
Click on the "Use this template" button to create a new repository based on this template.
-
Clone your newly created repository to your local machine:
git clone https://github.com/your-username/your-repository.git
-
Navigate into the cloned repository directory:
cd your-repository -
Install dependencies using npm or yarn:
npm install # or yarn install -
Start the development server:
npm run docs:dev # or yarn run docs:dev -
Open your browser and visit
http://localhost:5173to view your documentation website.
docs:dev: Start VitePress development server.docs:build: Build the documentation website for production.docs:preview: Preview the built documentation website.
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!
This template is open-source and available under the MIT 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.