From 92f35daeaf484c296e7ace37a0f0774285144f93 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Th=C3=A9o=20LUDWIG?= Date: Fri, 12 Jan 2024 00:50:17 +0100 Subject: [PATCH] docs: explain limitations/features --- README.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 0b76f4a..a0181d7 100644 --- a/README.md +++ b/README.md @@ -49,13 +49,12 @@ awesome.md:3 relative-links Relative links should be valid ["./invalid.txt" shou ### Additional features - Support images (e.g: `![Image](./image.png)`). -- Support anchors (heading fragment links) (e.g: `[Link](./awesome.md#existing-heading)`). +- Support links fragments similar to the [built-in `markdownlint` rule - MD051](https://github.com/DavidAnson/markdownlint/blob/main/doc/md051.md) (e.g: `[Link](./awesome.md#heading)`). - Ignore external links and absolute paths as it only checks relative links (e.g: `https://example.com/` or `/absolute/path.png`). ### Limitations -- Only images and links defined using markdown syntax are validated, html syntax is not supported (e.g: `` or ``). -- Anchors checking is limited to headings, other elements are not supported (e.g: with a "id", `
`). +- Only images and links defined using markdown syntax are validated, html syntax is ignored (e.g: `` or ``). Contributions are welcome to improve the rule, and to alleviate these limitations. See [CONTRIBUTING.md](./CONTRIBUTING.md) for more information.