node index.mjs ./docs/**/*.mdx

dev-docs-style-guide-linter

Fork of Quality Docs, a CLI tool to check the quality of writing in your project's markdown or plain text documentation.

Unified - interface for parsing, inspecting, transforming, and serializing content through syntax trees.

This tool uses retext to check the quality of writing in your project's documentation using these plugins;

• retext-equality warns on insensitive, inconsiderate language.
• retext-spell checks spelling against a US English dictionary and a custom dictionary.
• write-good
  • submodules
• remark-validate-links validates that Markdown links and images reference existing local files and headings.
• remark-lint-no-dead-urls ensures that external URLs in your Markdown are alive.
• retext-google-styleguide
• retext-syntax-urls classifies url-like values (example.com, index.html, www.alpha.bravo) as syntax, not natural language.
• retext-repeated-words check for repeated words.
  • Doesn’t warn for some words which do occur twice (the best exhibition they had had since)
  • Doesn’t warn for initialisms (D. D. will pop up with…)
  • Doesn’t warn for capitalised words (Duran Duran…)
• retext-indefinite-article check if indefinite articles (a and an) are used correctly.
• retext-assuming Check for unhelpful 'assuming' phrases such as 'just,' 'simply,' or 'obviously.'

Not currently enabled

• retext-readability checks the reading level of the whole document.
  • This project measures readability in text with several formulas: Dale–Chall, Automated Readability, Coleman–Liau, Flesch, Gunning fog, SMOG, and Spache.
• retext-intensify warns on filler, weasel and hedge words.
• retext-simplify warns on complicated phrases and checks for simpler alternatives.
• remark-lint checks for proper markdown formatting.

To Do

• use remark-lint-no-dead-urls to validate external links while ignoring example URLs