CHANGES.md, README.md

CHANGES.md

@@ -36,11 +36,13 @@ Unreleased
   + Now we call references to anchors in current file (e.g. `[a](#b)`) as
   `file-local` references instead of calling them `current file` (which was ambiguous).
 * [#233](https://github.com/serokell/xrefcheck/pull/233)
-  + Now xrefxcheck does not follow redirect links by default. It fails for permanent
+  + Now xrefcheck does not follow redirect links by default. It fails for permanent
     redirect responses (i.e. 301 and 308) and passes for temporary ones (i.e. 302, 303, 307).
 * [#231](https://github.com/serokell/xrefcheck/pull/231)
   + Anchor analysis takes now into account the appropriate case-sensitivity depending on
   the configured Markdown flavour.
+* [240](https://github.com/serokell/xrefcheck/pull/240)
+  + Now xrefcheck is able to detect possible copy-pastes relying on links and their names.
 
 0.2.2
 ==========

README.md

@@ -45,6 +45,7 @@ Comparing to alternative solutions, this tool tries to achieve the following poi
 * Supports external links (`http`, `https`, `ftp` and `ftps`).
 * Detects broken and ambiguous anchors in local links.
 * Integration with GitHub Actions.
+* Detects possible bad copy-pastes of links.
 
 ## Dependencies [↑](#xrefcheck)
 
@@ -148,6 +149,21 @@ There are several ways to fix this:
     * By default, `xrefcheck` will ignore links to localhost.
     * This behavior can be disabled by removing the corresponding entry from the `ignoreExternalRefsTo` list in the config file.
 
+1. How do I disable copy-paste check for specific links?
+    * Add a `<!-- xrefcheck: no duplication check in link -->` annotation before the link:
+      ```md
+      <!-- xrefcheck: no duplication check in link -->
+      Links with bad copypaste:
+      [good link](https://good.link.uri/).
+      [copypasted link](https://good.link.uri/).
+      ```
+      ```md
+      A [good link](https://good.link.uri/)
+      followed by an <!-- xrefcheck: no duplication check in link --> [copypasted intentionally](https://good.link.uri/).
+      ```
+    * You can use a `<!-- xrefcheck: no duplication check in paragraph -->` annotation to disable copy-paste check in a paragraph.
+    * You can use a `<!-- xrefcheck: no duplication check in file -->` annotation to disable copy-paste check within an entire file.
+
 ## Further work [↑](#xrefcheck)
 
 - [ ] Support link detection in different languages, not only Markdown.