Introduction

Edic (Editor In Chief) is QA tool for documentation, written in reStructuredText and CommonMark Markdown.

Edic is a wrapper around Docker; build for local usage.

Besides using a well configured editor, sometimes you want to run QA checks against your (whole) documentation.

Doing so, will provide important insights about the status or your docs.

This should be as effortless as possible.

Edic is born out of this need.

Be able to run the same checks locally and on CI, using the same configuration, without having a hard time to remember long command line syntaxes.

All checks are based on Rakpart, which is also used in CI.

✅

Last updated by sven on January 16, 2019.