search

tcort / markdown-link-check

checks all of the hyperlinks in a markdown text to determine if they are alive or dead
ISC License
581 stars 118 forks source link

Support yaml config file #197

Open chenrui333 opened 2 years ago

chenrui333 commented 2 years ago

I think it would be nice to support YAML config instead of JSON config

nejch commented 2 years ago

We do this in our package.json as a workaround so we can use YAML:

  "scripts": {
    "lint:links-yaml": "js-yaml -c .markdown-link-check.yml > .markdown-link-check.json",
    "lint:links": "yarn lint:links-yaml && markdown-link-check --quiet -c .markdown-link-check.json docs/**/*.md",
  },

But agreed it'd be nice to just have it natively ;)

MichaelSimons commented 2 months ago

I would like to see YAML supported is so that comments can be placed in the config file. Currently the json parser doesn't appear to support comments (not supported by the strict json protocol). I would like to have comments on some of the ignorePatterns in my usage.