Glossary
Every term the documentation uses without defining it on the spot, and where it is explained. The specifications behind them are in STANDARDS.md.
| Term | Meaning | Explained in |
|---|---|---|
| Alert | A blockquote that starts with a tag like [!NOTE], which GitHub renders as a colored callout. | Rules: Linters |
| Anchor | The fragment GitHub derives from a heading, which a #fragment link must match. | Anchors |
| Code block | A fenced or indented code block, or an HTML block, as CommonMark parses it; no rule looks inside. | Code blocks |
| Display width | The columns a string takes on screen; emoji and CJK take two. | Display width |
| Document | A Markdown file that belongs to the repository. | Document discovery |
| Exclusion | A path, path-except or rule that keeps a formatter from a document, or drops a linter's issue. | Configuration: Exclusions |
| Feature | A part of the markright-core crate a build can leave out, such as the disk or the threads, which the playground does without. | Architecture: Crates |
| Formatter | A rule that rewrites lines; fmt applies it and check reports what it would change. | Rules: Formatters |
| Front matter | YAML between --- lines, or TOML between +++ lines, at the start of a document; no rule reads it as Markdown. | Code blocks |
| Index document | The document that must link every other one, CONTENTS.md by default. | Configuration |
| Issue | One problem at one line, named by the formatter or linter that found it. | Rules: Commands |
| Lazy continuation | A line without > that Markdown still joins to the paragraph of the blockquote above it. | Rules: Linters |
| Linter | A rule that reports issues and changes nothing. | Rules: Linters |
| Output format | Where and how check writes issues: text, Checkstyle or SARIF. | Configuration: Output |
| Playground | The page of the documentation site that runs markright, compiled to WebAssembly, on a document in the browser. | Architecture: The documentation site |
| Protected span | Part of a line the formatters leave as written: inline code, inline HTML, link targets. | Protected spans |
| Reference link | A link written [text][label], whose target is in a definition, [label]: target, elsewhere in the document. | Rules: Linters |
| Registry | The list of every formatter, or every linter, that the runner, the commands and the configuration follow. | Architecture: Registries |
| Separator row | The second row of a table, of dashes and colons, which also sets each column's alignment. | Rules: Formatters |