Checks

Edic uses Rakpart checks.

Markdown

Markdown code style linter for CommonMark.

From in your docs directory:

edic md

.

• remark-lint documentation on Rakpart.

Linkcheck

Link validation for .md and .rst files.

Per default links to 127.0.0.1 and localhost are ignored.

From in your docs directory:

edic linkcheck

.

• Linkcheck docs on Rakpart.

reStructuredText

A opinionated style checker for rst based documentation.

From in your docs directory:

edic rst

Default Settings

• Invalid rst format - D000
• Lines should not be longer than 180 characters - D001
  • RST exception: line with no whitespace except in the beginning
  • RST exception: lines with http or https urls
  • RST exception: literal blocks
  • RST exception: rst target directives
• No trailing whitespace - D002
• No tabulation for indentation - D003
• No carriage returns (use unix newlines) - D004
• No newline at end of file - D005

.

• reST docs on Rakpart.

Last updated by sven on January 22, 2019.