Usage

Install yamark, run the formatter, and choose an integration.

Install

Build the yamark binary from a checkout:

cargo build --bin yamark

Run the debug binary directly:

target/debug/yamark format config.yaml docs/

Install the binary from the checkout:

cargo install --path .

Format files

Format one or more files or directories in place:

yamark format config.yaml docs/

Format the current directory:

yamark format

By default, Markdown prose wraps at column 72 without forcing sentence boundaries. Override this behavior with --wrap, for example:

yamark format --wrap sentence:88 docs/

Directory traversal respects .gitignore, .ignore, and global Git ignore files by default.

CI and stdin

Use check, diff, or stdin modes for integrations:

yamark format --check docs/
yamark format --diff docs/
yamark format --stdin-file-path config.yaml < config.yaml

--check and --diff do not write files. Both exit 1 when any selected file would change.

Use --diagnostics for preservation notes, or --skip-embedded-formatters when another formatter owns source-code chunks in the same save or CI chain.

Integrations

  • Editors: VS Code, Positron, and compatible forks - commands, settings, format-on-save, formatter chaining, and logs.
  • Git Filter: store Markdown sentence-per-line in Git while keeping the working tree column-wrapped.
  • Reference: the full CLI option list, yamark.toml schema, directive syntax, and supported syntax coverage.
  • CLI Help: rendered yamark --help, yamark format --help, and yamark git-filter --help output.