Standards
The specifications this tool follows, what for, and where the documentation covers it.
| Standard | Title | Used for | Explained in |
|---|---|---|---|
| CommonMark 0.31.2 | CommonMark Spec | parsing every document: blocks, code, links and their positions | Code blocks |
| GFM 0.29 | GitHub Flavored Markdown Spec | tables, strikethrough, task lists, and which plain URLs bare-urls makes links | Rules: Formatters |
| GitHub alerts | GitHub alert syntax | the allowed alert types | Rules: Linters |
| UAX #11 | Unicode East Asian Width | which characters are two columns wide | Display width |
| UTS #51 | Unicode Emoji | emoji presentation and U+FE0F | Display width |
| YAML 1.2 | YAML Ain't Markup Language 1.2 | .markright.yaml and YAML front matter | Configuration |
| TOML 1.1.0 | Tom's Obvious Minimal Language 1.1.0 | .markright.toml and TOML front matter | Configuration |
| SARIF 2.1.0 | Static Analysis Results Interchange Format | the sarif output | Configuration: Output |
| Checkstyle XML | Checkstyle report format | the checkstyle output | Configuration: Output |
| JSON Schema 2020-12 | JSON Schema | describing the configuration file for editors | Configuration: Schema |
| Rust regex syntax | Syntax of the regex crate | exclusion paths and texts | Configuration: Exclusions |
| SemVer 2.0.0 | Semantic Versioning | release tags | Development: Releasing |
| Conventional Commits | Conventional Commits 1.0.0 | commit messages and pull request titles | Contributing |