This documetation is based on markdown files that are stored in each components source code repository. We use a linter to ensure a high standard.

Tool

Remark is used to lint and autofix the markdown files.

• github.com/wooorm/remark
• github.com/wooorm/remark-lint

Installation

npm i -g remark-cli remark-lint

Configuration

• /documentation/.remarkrc

Linting

A full list of available rules are available here

Transformation

A full list of options are available here

Disable rules

<!--lint disable [rule-id]-->
...
<!--lint enable [rule-id]-->

Use

First of all navigate to the documentations directory.

cd documentation

lint

single file

remark documentation/miscellaneous/documentation.md

all files

remark .

autofix

single file

remark documentation/miscellaneous/documentation.md -o .

all files

remark . -o .

Diasable/Enable rules

<!--lint disable no-duplicate-headings-->
...
<!--lint enable no-duplicate-headings-->