Note: This project has not been tested extensively, and may give false positives and/or false negatives if advanced Markdown (like MultiMarkdown) is used.

• CMake
• NPM:
  • alex to detect insensitive, inconsiderate writing;
  • markdown-spellcheck for spellcheck, using open source Hunspell dictionary files;
  • remark-cli for linting.
• Travis CI

1. Clone the project: git clone https://github.com/stvhwrd/mdci.git

2. Change directory: cd mdci

3. Install NPM packages: npm install

4. Run tests on .md files in the current directory, by running any of the commands below.

• make offensive-wording

Check for words and phrases from a list of common inequalities and exclusivities and, separately, a list of profanities (NSFW).

Check spelling and ask user how to handle each perceived spelling error, allowing the user to interactively build their dictionary (.spelling) file on a per-word basis.

• make spellcheck-interactive

Check spelling and fail on any perceived spelling error that is not in the custom dictionary (.spelling).

• make spellcheck-auto

Check syntax and structure of Markdown, fail on any errors.

• make lint-markdown

Run sensitivity check and linter as normal, but run spellcheck interactively. This test sequence is suitable to run before committing Markdown files to version control.

• make test-pre-commit

Run all tests in headless (non-interactive) mode.

• make test

See GitHub Issues.

Big thanks to @kvz for their blog post which is the basis of - and inspiration for - this project.