stvhwrd / mdci Goto Github PK

A switch to markdownlint-cli may provide for more granular control of linting rules.

(markdownlint-cli is the CLI version of DavidAnson's markdownlint)

I want this to be easily added to a repository that hosts Markdown files such that someone can basically "drag and drop" this setup into their project.

See Git-Tools-Submodules.

When the repo is downloaded or cloned by the end user

• the user dictionary .spelling is dirty and irrelevant,
• the sample.md is unnecessary

We need to produce a script like Homebrew's install script to clone only the necessary files. This would be an alternative to #1 (deploying as a git submodule).

An effective install script would:

• be interactive
• selectively download the necessary files from the repository
• check user's system for npm
  • instruct user on how to install if npm not present
• conduct some kind of testing to verify that the install of mdci was successful.