Skip to content

CarbonCommunity/Carbon.Documentation

Repository files navigation

Carbon.Documentation

Dev Setup

Recommended IDEs

  1. VSCode (or any fork of it) – currently has the best support for the packages used in this project: Vue.js, Tailwind.
  2. WebStorm – can be used as an alternative to VSCode, but lacks some minor features.

Setting up the server

  1. Run setup.bat to install all dependencies.
  2. Run npm run docs:dev to start the dev server, which will automatically apply any changes you make.
  3. Run npm run docs:build to build the site (to ensure everything builds correctly and can be deployed to GitHub Pages without problems).
  4. Run npm run docs:preview to preview the documentation built by the previous command.

About

Carbon and development within Rust modding environment documentation.

Topics

Resources

License

Code of conduct

Stars

Watchers

Forks

Contributors 6