/sigmahq.github.io

Official Website Of The Sigma Project

Primary LanguageVue


Sigma Logo


Tests Badge Sigma Official Badge Status Badge

Welcome to the official Sigma website, a central hub for everything related to the Sigma project. Please visit sigmahq.io for a full overview of the website

Contributing

We highly encourage contributions to make sure the website is serving the latest updates and information, please open a PR if you have any suggestions or fixes.

The Sigma website is powered by Vitepress. To learn more about Vitepress, click here.

Installation

To install the documentation locally, install NodeJS 16+ and npm, and run the following.

npm install

Running

To start a local preview server of the documentation locally, run the following.

npm run docs:dev

Building

Finally, to compile the documentation into a bundle locally, run the following.

npm run docs:build
npm run docs:serve

Testing / Linting

Before contributing to the documentation, please make sure to run the following to ensure all docs are linted correctly.

# To run the linter
npm run lint

# To fix any linting issues
npm run lint:fix

Acknowledgement

A huge thank you goes to Alex (@sifex) for dedicating the time and help building this website

Maintainers