https://github.com/triole/mdlint

simple mdlinter that checks the document's front matter
https://github.com/triole/mdlint

command-line front-matter markdown validation

Last synced: 4 months ago
JSON representation

simple mdlinter that checks the document's front matter

• Host: GitHub
• URL: https://github.com/triole/mdlint
• Owner: triole
• Created: 2022-03-09T11:43:19.000Z (almost 4 years ago)
• Default Branch: master
• Last Pushed: 2024-01-08T15:45:32.000Z (about 2 years ago)
• Last Synced: 2024-01-08T16:56:24.498Z (about 2 years ago)
• Topics: command-line, front-matter, markdown, validation
• Language: Go
• Homepage:
• Size: 28.3 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md

Awesome Lists containing this project

README

          
# Mdlint ![test](https://github.com/triole/mdlint/actions/workflows/test.yaml/badge.svg) ![build](https://github.com/triole/mdlint/actions/workflows/build.yaml/badge.svg)

- [Synopsis](#synopsis)

- [Help](#help)

## Synopsis

A simple markdown linter that currently only evaluates if the file's front matter is valid.

## Help

```go mdox-exec="r -h"

simple mdlinter that checks the document's front matter

Arguments:

  []    can be file or folder, if folder files to process are detected

                recursively

Flags:

  -h, --help                    Show context-sensitive help.

  -f, --filter=REGEX            file detection filter when folder given, default

                                is \.md$

  -e, --fmkeys=KEY=VALUE;...    evaluate a distinct front matter key and its

                                value type, can be used multiple times (i.e.

                                -e index=int -e no=float -e title=string -e

                                tags=slice -e m=map)

  -s, --fmstrinct               strictly evaluate front matter, documents

                                are considered to be invalid if front matter

                                contains a key that wasn't provided with the

                                'fmkeys' arg

  -o, --invalid-only            print out validation result of invalid files

                                only

  -V, --version-flag            display version

```