This is official repository for documentation of Carbon framework and other useful stuff.
The website is built using VitePress, powered by Vite and Vue.js. It uses Tailwind CSS v3 for styling.
- VSCode (or any fork of it) – currently has the best support for the packages used in this project: Vue.js, Tailwind.
- WebStorm – can be used as an alternative to VSCode, but lacks some minor features.
- Run
setup.batto install all dependencies. - Run
npm run docs:devto start the dev server, which will automatically apply any changes you make. - Run
npm run docs:buildto build the site (to ensure everything builds correctly and can be deployed to GitHub Pages without problems). - Run
npm run docs:previewto preview the documentation built by the previous command.