Editor In Chief
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github
command
docs
release-notes
vendor/github.com/codegangsta/cli
.gitignore
.gitmodules
.goreleaser.yml
CHANGELOG.md
Gopkg.lock
Gopkg.toml
LICENSE
Makefile
README.md
VERSION
commands.go
main.go
netlify.toml
version.go

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

Documentation

Read the documentation on the website.

Usage

edic -h
NAME:
   edic - Editor In Chief

USAGE:
   edic [global options] command [command options] [arguments...]

VERSION:
   0.0.1

AUTHOR:
   testthedocs

COMMANDS:
     md         Checks Markdown Syntax (CommonMark Style)
     linkcheck  Checks Links
     style      Checks Style (based on Vale)
     rst        Checks reStructuredText
     help, h    Shows a list of commands or help for one command

GLOBAL OPTIONS:
   --help, -h     show help
   --version, -v  print the version

Install

Browse o 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