README.md

Edic

Editor In Chief

Description

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.

All checks are based on Rakpart

Prerequisites

• Docker

Documentation

Read the documentation on the website.

Usage

edic help
QA checks for documentation, written in reStructuredText and CommonMark Markdown.

Edic is a wrapper around Docker; build for local usage.
All tests are based on Rakpart (https://rakpart.testthedocs.org).

Usage:
  edic [command]

Available Commands:
  help        Help about any command
  linkcheck   Linkchecker for rst and md files
  md          Checks Markdown Syntax (CommonMark Style)
  rst         Checks reStructuredText Syntax
  version     Show the version information

Flags:
      --config string   config file (default is $HOME/.edic.yaml)
  -h, --help            help for edic
  -t, --toggle          Help message for toggle

Use "edic [command] --help" for more information about a command.

Install

Browse to the release page and download the binary according to your OS.

To install, use go get:

go get -d github.com/testthedocs/edic

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

License

MIT

Acknowledgments

• This is work in progress, the code and features are still early alpha
• Functionality will change