Files
detekt/website
Brais Gabín a10e957c3d Improve readme (#4914)
* Move integrations down

* Remove old integration

* Move more integrations down

* More improvements

* Improve the detekt features

* Update link

* Improve website/docs/intro.mdx

* Add links to kotlin homepage

* Update README.md

Co-authored-by: schalkms <30376729+schalkms@users.noreply.github.com>

* Add complexity reports back

Co-authored-by: schalkms <30376729+schalkms@users.noreply.github.com>
2022-06-14 10:05:28 +02:00
..
2022-04-24 13:23:56 +01:00
2022-06-14 10:05:28 +02:00
2022-04-24 13:23:56 +01:00
2022-04-24 13:23:56 +01:00
2022-04-24 13:23:56 +01:00
2022-04-24 13:23:56 +01:00
2022-04-24 13:23:56 +01:00

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.