Reference
Use this section to look up a specific behavior, setting, or syntax. If you are learning Yamark, start with Usage, then work through Examples and the guided Directives page.
Find what you need
Supported files and syntax
Will Yamark format this file or construct? Check automatically selected and explicitly marked inputs, preserved syntax, and delegated formatters.
Failures and unchanged content
Check which input Yamark rejects, which regions it leaves alone, and what happens to a file when parsing, formatting, decoding, external formatter execution, or I/O fails.
Formatting settings
Find the control for wrapping, canonical Markdown, footnotes, YAML layout, widths, indentation, diagnostics, or embedded formatters.
Configuration
Look up config discovery and the accepted [format], [template], [embedded], and [paths] tables in yamark.toml.
Directive syntax
Look up the exact fmt: comment form, target, scope, accepted values, and effect for a source-local directive.
Command line
Check write, check, diff, and stdin behavior; output streams and exit status; or generated help for Yamark, format, and the git-filter command group.
Choose a control surface
The same formatting behavior can be available at more than one scope.
| Scope | Surface | Use it for |
|---|---|---|
| One file, region, or target | fmt: directives |
The most local choice, stored beside the affected content. |
| One Markdown document | Front-matter options | Markdown behavior that travels with the document. |
| A repository or subtree | yamark.toml |
Shared defaults and path-specific formatter setup. |
| One run | Command-line flags | A temporary choice or CI invocation. |
The Formatting settings page groups these surfaces by the output they control, so you can find every place a setting is available.