Documentation for Promitor

Contains all the documentation for promitor.io

Running the documentation locally

You can easily run the documentation locally by using Jekyll:

⚡ tkerkhove@tomkerkhove C:\promitor
❯  bundle exec jekyll serve

Markdownlint

We use markdownlint to ensure that our markdown follows the same set of formatting guidelines.

You can install markdownlint by installing any required npm packages:

npm install

You can then run markdownlint using the following command:

npm run markdownlint

The markdownlint repository has information about various tools you can use to integrate it with various different text editors.