mdtools/mdlint
mdtools/mdlint
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

update README

Browse source
This commit is contained in:
JMARyA 2024-03-26 13:20:03 +01:00
parent 6d33cf285e
commit 94b2373222
Signed by: jmarya
GPG key ID: 901B2ADDF27C2263
1 changed files with 12 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
README.md
View file

@ -4,5 +4,15 @@ Validate markdown frontmatter using [JSON Schemas](https://json-schema.org)
## Usage
```shell
$ mdlint [OPTION] <SchemaFile> <MarkdownFile>
```
$ mdlint [OPTIONS] <SchemaFile> <MarkdownFile>
```
### Options
| Option | Description |
| ---------------------------------- | ------------------------------------------------------------------------------------- |
| `-g, --greedy` | Require all properties to be present even if they are not strictly required in schema |
| `-e, --empty-frontmatter` | Treat missing frontmatter as empty frontmatter |
| `-i, --ignore-missing-frontmatter` | Dont print an error when no frontmatter has been found |
| `-h, --help` | Print help |
| `-V, --version` | Print version |