Skip to content

remark-lint

remark-lint documentation

remark-lint - GitHub

Configuration in Mega-Linter

Variable Description Default value
MARKDOWN_DEFAULT_STYLE For remark-lint to be active, MARKDOWN_DEFAULT_STYLE must be remark-lint markdownlint
MARKDOWN_REMARK_LINT_ARGUMENTS User custom arguments to add in linter CLI call
Ex: -s --foo "bar"
MARKDOWN_REMARK_LINT_FILTER_REGEX_INCLUDE Custom regex including filter
Ex: (src|lib)
Include every file
MARKDOWN_REMARK_LINT_FILTER_REGEX_EXCLUDE Custom regex excluding filter
Ex: (test|examples)
Exclude no file
MARKDOWN_REMARK_LINT_FILE_EXTENSIONS Allowed file extensions. "*" matches any extension, "" matches empty extension. Empty list excludes all files
Ex: [".py", ""]
[".md"]
MARKDOWN_REMARK_LINT_FILE_NAMES_REGEX File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: ["Dockerfile(-.+)?", "Jenkinsfile"]
Include every file
MARKDOWN_REMARK_LINT_CONFIG_FILE remark-lint configuration file name
Use LINTER_DEFAULT to let the linter find it
.remarkrc
MARKDOWN_REMARK_LINT_RULES_PATH Path where to find linter configuration file Workspace folder, then Mega-Linter default rules
MARKDOWN_REMARK_LINT_DISABLE_ERRORS Run linter but consider errors as warnings true

IDE Integration

Use remark-lint in your favorite IDE to catch errors before Mega-Linter !

IDE Extension Name Install
Atom linter-remark Visit Web Site
Sublime Text SublimeLinter-contrib-remark-lint Visit Web Site
vim ale Visit Web Site
Visual Studio Code vscode-remark-lint Visit Web Site

Mega-Linter Flavours

This linter is available in the following flavours

Flavor Description Embedded linters Info
all Default Mega-Linter Flavor 83 Docker Image Size (tag) Docker Pulls
dart Optimized for DART based projects 37 Docker Image Size (tag) Docker Pulls
documentation Mega-Linter for documentation projects 36 Docker Image Size (tag) Docker Pulls
dotnet Optimized for C, C++, C# or VB based projects 42 Docker Image Size (tag) Docker Pulls
go Optimized for GO based projects 38 Docker Image Size (tag) Docker Pulls
java Optimized for JAVA based projects 37 Docker Image Size (tag) Docker Pulls
javascript Optimized for JAVASCRIPT or TYPESCRIPT based projects 45 Docker Image Size (tag) Docker Pulls
php Optimized for PHP based projects 40 Docker Image Size (tag) Docker Pulls
python Optimized for PYTHON based projects 43 Docker Image Size (tag) Docker Pulls
ruby Optimized for RUBY based projects 37 Docker Image Size (tag) Docker Pulls
rust Optimized for RUST based projects 37 Docker Image Size (tag) Docker Pulls
salesforce Optimized for Salesforce based projects 37 Docker Image Size (tag) Docker Pulls
scala Optimized for SCALA based projects 37 Docker Image Size (tag) Docker Pulls
swift Optimized for SWIFT based projects 37 Docker Image Size (tag) Docker Pulls
terraform Optimized for TERRAFORM based projects 39 Docker Image Size (tag) Docker Pulls

Behind the scenes

How are identified applicable files

  • File extensions: .md

Example calls

remark --frail myfile.md
remark --frail --rc-path .remarkrc myfile.md
remark --frail -o --rc-path .remarkrc myfile.md

Help content

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

  CLI to process Markdown with remark

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
      --ignore-path-resolve-from dir|cwd  resolve patterns in `ignore-path` from its directory or cwd
      --ignore-pattern <globs>            specify ignore patterns
      --silently-ignore                   do not fail when given ignored files
      --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

Installation on mega-linter Docker image