{"repo":"vweevers/hallmark","free":true,"listed":false,"github":"https://github.com/vweevers/hallmark","clone":"git clone https://github.com/vweevers/hallmark.git","description":"Markdown Style Guide, with linter and automatic fixer.","language":"JavaScript","stars":49,"topics":["markdown","documentation","remark","tooling","linter","fixer"],"license":"GPL-3.0","category":"dev-tools","readme_excerpt":"hallmark Markdown Style Guide, with linter and automatic fixer. :sparkles:\\ Powered by [ remark ][remark]. Why This module saves you time in three ways: - No configuration. The easiest way to enforce markdown code quality in your project. No decisions to make. No remark plugins to manage. - Automatically format markdown. Run hallmark fix to format markdown, wrap GitHub issues and usernames in links, autocomplete a CHANGELOG.md following Common Changelog and more. - Catch style issues & mistakes early. Save code review time by eliminating back-and-forth between reviewer & contributor. Quick Start Lint .md files: Fix markdown files in place: Fix custom files: Add new minor version or existing version to changelog, optionally without content: What You Might Do Add hallmark to your package.json : Markdown is then checked automatically when you run npm test : Requirements - The working directory must be a git repository - It must either contain a package.json with a repository property, or have a git origin remote Rules - Use - as marker for bullets of items in unordered lists ( - item ) - Use as marker for emphasis ( emphasis ) - Use as marker for strong ( strong ) - Use x as marker for checkboxes ( - [x] item ) - Use backtick as marker for fenced code block - Always use fences for code blocks - Use --- for thematic breaks - Insert links to GitHub issues, PRs and usernames (not linted) - Collapse a Table of Contents if it exists (not linted) - End file with newline - No dead link","default_branch":null,"files":null,"tree":[],"storefront":"/r/vweevers","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/vweevers/hallmark/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}