syseleven / markdownlint-rules-grav-pages

Markdownlint rules for Grav Pages

Markdown Lint Rules for Grav Pages

This package contains additional linting rules for markdownlint that check if a Markdown file is a valid Grav CMS page.

Rules

valid-images

• Checks if a relatively referenced image is present.

valid-internal-links

• Checks if a link to a another markdown file in the same repo is correct.

valid-metadata-block

• Checks if a Frontmatter metadata block is present and valid.

Usage

See https://github.com/DavidAnson/markdownlint/blob/master/doc/CustomRules.md

Development

To lint all source files run:

$ npm run lint

To run all tests:

$ npm run test

To release a new version, ensure that the checkout is clean, then run:

$ npm run release && git push --follow-tags origin master && npm publish