This document describes how you can contribute documentation to Promitor.
The documentation for Promitor is stored in /docs
and uses Jekyll with GitHub Pages.
You can easily run the documentation locally by using Jekyll:
- Navigate to the
docs
directory
⚡ tkerkhove@tomkerkhove C:\promitor-legacy-docs
❯ cd docs
- Serve documentation with Jekyll on
http://127.0.0.1:4000
⚡ tkerkhove@tomkerkhove C:\promitor-legacy-docs
❯ bundle exec jekyll serve
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.