CLI Help

yamark

An ultra-fast YAML and Markdown formatter.

Run `yamark <COMMAND> --help` for command-level help.

Usage: yamark <COMMAND>

Commands:
  format
  git-filter  Git clean/smudge filter helpers for Markdown files
  help        Print this message or the help of the given subcommand(s)

Options:
  -h, --help
          Print help (see a summary with '-h')

yamark format

Usage: yamark format [OPTIONS] [PATHS]...

Arguments:
  [PATHS]...

Options:
      --check
      --diff
      --diagnostics
      --verify                       Reparse changed YAML and reject invalid or value-changing output
      --stdin-file-path <PATH>
      --config <PATH>
      --wrap <WRAP>                  [default: 72]
      --canonical
      --preserve-footnotes
      --line-width <LINE_WIDTH>      [default: 80]
      --prose-width <PROSE_WIDTH>    [default: 72]
      --indent-width <INDENT_WIDTH>  [default: 2]
      --compact
      --skip-embedded-formatters
  -h, --help                         Print help

yamark git-filter

Git clean/smudge filter helpers for Markdown files.

These commands read Markdown from stdin and write formatted Markdown to stdout
for Git attributes filters.

Configure the filter driver with:
  yamark git-filter adopt
  yamark git-filter join
  yamark git-filter check
  yamark git-filter setup
  yamark git-filter teardown
  git config filter.yamark-md.clean "yamark git-filter clean --stdin-filename %f"
  git config filter.yamark-md.smudge "yamark git-filter smudge --stdin-filename %f --markdown-wrap-at-column 72"

Git only runs the filter for paths matched by attributes. Put these patterns in
.git/info/attributes for personal use or .gitattributes for a shared repo:
  *.md filter=yamark-md
  *.qmd filter=yamark-md
  *.Rmd filter=yamark-md
  *.rmd filter=yamark-md

Usage: yamark git-filter <COMMAND>

Commands:
  clean
  smudge
  adopt     Adopt the yamark Git filter for a shared repository
  join      Join a repository that has already adopted the yamark Git filter
  check     Check committed yamark Git filter blobs round-trip safely
  setup     Configure the yamark Git filter in a repository
  teardown  Remove the local yamark Git filter setup from a repository
  help      Print this message or the help of the given subcommand(s)

Options:
  -h, --help
          Print help (see a summary with '-h')