remark-cli

remark-cli

Command line interface for remark.

• Interface by unified-args
• Loads remark- plugins
• Searches for Markdown extensions
• Ignores paths found in .remarkignore files
• Loads configuration from .remarkrc, .remarkrc.js files
• Uses configuration from remarkConfig fields in package.json files

Sponsors

Gatsby 🥇	Vercel 🥇	Netlify
Holloway	ThemeIsle 🥉	BoostIO 🥉	Expo 🥉	You?

Install

npm:

npm install remark-cli

Use

# Add a table of contents to `readme.md`
$ remark readme.md --use toc --output

# Lint Markdown files in the current directory
# according to the Markdown style guide.
$ remark . --use preset-lint-markdown-style-guide

CLI

See unified-args, which provides the interface, for more info on all available options.

Usage: remark [options] [path | glob ...]

  CLI to process Markdown with remark using plugins

Options:

  -h  --help                output usage information
  -v  --version             output version number
  -o  --output [path]       specify output location
  -r  --rc-path <path>      specify configuration file
  -i  --ignore-path <path>  specify ignore file
  -s  --setting <settings>  specify settings
  -e  --ext <extensions>    specify extensions
  -u  --use <plugins>       use plugins
  -w  --watch               watch for changes and reprocess
  -q  --quiet               output only warnings and errors
  -S  --silent              output only errors
  -f  --frail               exit with 1 on warnings
  -t  --tree                specify input and output as syntax tree
      --report <reporter>   specify reporter
      --file-path <path>    specify path to process as
      --tree-in             specify input as syntax tree
      --tree-out            output syntax tree
      --inspect             output formatted syntax tree
      --[no-]stdout         specify writing to stdout (on by default)
      --[no-]color          specify color in report (on by default)
      --[no-]config         search for configuration files (on by default)
      --[no-]ignore         search for ignore files (on by default)

Examples:

  # Process `input.md`
  $ remark input.md -o output.md

  # Pipe
  $ remark < input.md > output.md

  # Rewrite all applicable files
  $ remark . -o

Security

As Markdown is sometimes used for HTML, and improper use of HTML can open you up to a cross-site scripting (XSS) attack, use of remark can also be unsafe. When going to HTML, use remark in combination with the rehype ecosystem, and use rehype-sanitize to make the tree safe.

Use of remark plugins could also open you up to other attacks. Carefully assess each plugin and the risks involved in using them.

Contribute

See contributing.md in remarkjs/.github for ways to get started. See support.md for ways to get help. Ideas for new plugins and tools can be posted in remarkjs/ideas.

A curated list of awesome remark resources can be found in awesome remark.

This project has a code of conduct. By interacting with this repository, organization, or community you agree to abide by its terms.

License

MIT © Titus Wormer