mirror of
https://github.com/YunoHost/doc.git
synced 2024-09-03 20:06:26 +02:00
7a01793062
* Revert "Revert "markdown format"" * fix formating * fix readme * add .markdownlint.json * add markdownlint-rules-grav-pages * add markdownlint-rules-grav-pages files * add license for Markdown Lint Rules for Grav Pages * fix [figure] mess * fix [figure] mess 2 * fix [figure] mess 3 * maj .gitignore * various fixes * fix markdownlint-rules-grav-pages * second formater pass * various manual fixes * add .markdownlintignore * markdownlintignore: auto-generated pages * disable proper-names for html_elements * another bunch of various markdown fixes * Update pages/02.administer/10.install/20.dns_config/dns_config.es.md Co-authored-by: tituspijean <titus+yunohost@pijean.ovh> --------- Co-authored-by: Alexandre Aubin <4533074+alexAubin@users.noreply.github.com> Co-authored-by: tituspijean <titus+yunohost@pijean.ovh> |
||
|---|---|---|
| .. | ||
| lib | ||
| rules | ||
| tests | ||
| .eslintrc | ||
| .gitignore | ||
| .travis.yml | ||
| CHANGELOG.md | ||
| LICENSE | ||
| package-lock.json | ||
| package.json | ||
| README.md | ||
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