Skip to content
This repository has been archived by the owner on Dec 4, 2019. It is now read-only.

ntrrg/docker-md-linter

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

9 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Docker Build Status

Tag Status
latest (Dockerfile)
watch (Dockerfile)

Usage

docker run --rm -itv /path/to/my/md-files:/files ntrrg/md-linter

For any custom configuration, just create a file (.remarkrc or .remarkignore) in the root folder of the markdown files (see https://github.com/unifiedjs/unified-engine/blob/master/doc/configure.md).

The file .remarkplugis allows the installation of plugins, useful for some special cases, like frontmatter support. This must be a line separated list of plugins.

.remarkplugins:

remark-frontmatter

.remarkrc:

{
  "plugins": [
    "remark-preset-lint-recommended",
    "remark-frontmatter",
    [
      "remark-lint-list-item-indent",
      "space"
    ]
  ]
}

The watch tag provides an implementation with a file system watcher, so any time that some markdown file is edited, it will automatically restart the linter. Just like the linter, the file system watcher supports custom configurations with a file (nodemon.json) in the root folder (see https://github.com/remy/nodemon#config-files).

docker run --rm -itv /path/to/my/md-files:/files ntrrg/md-linter:watch

Acknowledgment

Working on this project I use/used: