detekt/website/README.md

Website

Detekt website is built using Docusaurus 2.

Installation

First please install all the dependencies with

$ yarn

Local Development

$ yarn start

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

Generated docs for rules

Please note that rules documentation is generated by the Detekt project starting from the rule source code. In order to see them inside the website you will have to:

$ yarn generate

Build

$ yarn generate-and-build

This command generates static content into the build directory and can be served using any static contents hosting service.