bd500af2ff
Update to remark-lint-prohibited-strings 1.0.3 to avoid false positives with GitHub team names which must be lowercased no matter what our prohibited-strings rules say about a particular string. PR-URL: https://github.com/nodejs/node/pull/20742 Refs: https://github.com/nodejs/node/pull/20740 Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> |
||
|---|---|---|
| .. | ||
| LICENSE | ||
| cli.js | ||
| package-lock.json | ||
| package.json | ||
| readme.md | ||
readme.md
remark-cli 
Command-line interface for remark.
- Loads
remark-plugins - Searches for markdown extensions
- Ignores paths found in
.remarkignorefiles - Loads configuration from
.remarkrc,.remarkrc.jsfiles - Uses configuration from
remarkConfigfields inpackage.jsonfiles
Installation
npm:
npm install remark-cli
Usage
# 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 information 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
-p --preset <presets> use presets
-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
--file-path <path> specify path to process as
--tree-in specify input as syntax tree
--tree-out output 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