You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The strict extension mode makes the .md extension mandatory in links to recognized md files.
This means that a link to a markdown file not containing the .md extension will raise a warning:
This only raises an error when the .md extension is missing on a md file. If the link is to a directory because it will automatically redirect to the README.md or index.md file inside that directory, it will NOT raise a warning.
Since dir is a directory containing a README.md file, this will NOT raise an error:
[test17](/dir)
[test18](/dir#test)
Since other is a markdown file whose .md extension is missing, this will raise an error:
[test7](/other#ctx-get-name)
[test8](/other#cccc)
Checking markdown...
2 warning was found
File found with this name but .md extension missing: [test7](/other#ctx-get-name) (/Users/charlottevermandel/check-md/test/fixtures/docs1/test.md:17:1)
File found with this name but .md extension missing: [test8](/other#cccc) (/Users/charlottevermandel/check-md/test/fixtures/docs1/test.md:19:1)
Usage
it is used, as --fix, by adding the option without parameter.
Strict Extension Mode
The strict extension mode makes the .md extension mandatory in links to recognized md files.
This means that a link to a markdown file not containing the .md extension will raise a warning:
This only raises an error when the .md extension is missing on a md file. If the link is to a directory because it will automatically redirect to the
README.md
orindex.md
file inside that directory, it will NOT raise a warning.Since
dir
is a directory containing a README.md file, this will NOT raise an error:Since
other
is a markdown file whose .md extension is missing, this will raise an error:Usage
it is used, as --fix, by adding the option without parameter.
Implementation
I'm working on it on this PR: bidoubiwa#1. I will make a PR here once it's done.
The text was updated successfully, but these errors were encountered: