Writing Snippets

Custom Snippets for (technical) writing
Explore the docs »

Report Bug · Request Feature

Table of Contents

• About the Project
• Usage
• Contributing
• License
• Credits

About

Custom snippets for (technical) writing with Markdown.

Usage

Vale

Vale is a command-line tool that brings code-like linting to prose

• vale-off: Disable Vale
• vale-on: Enable Vale

Markdown-Link-Check

Markdown-Link-Check extracts links from markdown texts and checks whether each link is alive (200 OK) or dead.

• md-link-off: Disable link-check
• md-link-on: Enable link-check

Markdownlint

A Node.js style checker and lint tool for Markdown/CommonMark files.

• md-lint-disable: Disable markdownlint
• md-lint-enable: Enable markdownlint

Alex

Alex — Catch insensitive, inconsiderate writing

• alex-disable: Disable alex
• alex-enable: Enable alex

CSpell

A Spell Checker for Code

• cspell-disable: Disable cspell
• cspell-enable: Enable cspell

Contributing

We are a community effort, and everybody is most welcome to participate!

Be it filing bugs, formulating enhancements, creating pull requests, or any other means of contribution, we encourage contributions from everyone.

License

Distributed under the MIT license