Skip to content

Commit 80c49b4

Browse files
committed
Enhance the docs
1 parent b8bbaca commit 80c49b4

File tree

1 file changed

+22
-2
lines changed

1 file changed

+22
-2
lines changed

ReadMe.md

Lines changed: 22 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
[textlint](https://github.com/textlint/textlint) rule
1010
to make sure every link in a document is available.
1111

12-
The primary target of this rule is Markdown documents, while it may also work for plain text documents (See tests).
12+
The primary target of this rule is Markdown documents, but it also works on plain text documents (See tests).
1313

1414
## Installation
1515

@@ -24,6 +24,26 @@ $ npm install textlint textlint-rule-no-dead-link
2424
$ textlint --rule textlint-rule-no-dead-link text-to-check.txt
2525
```
2626

27+
## Features
28+
29+
### Dead Link Detection
30+
31+
Shows an error if a link is dead (i.e. its server returns one of the ["non-ok" responses](https://fetch.spec.whatwg.org/#ok-status)).
32+
33+
### Obsolete Link Detection
34+
35+
[![Fixable](https://img.shields.io/badge/textlint-fixable-green.svg?style=social)](https://textlint.github.io/)
36+
37+
Shows an error if a link is obsolete or moved to another location (i.e. its server returns one of the ["redirect" responses](https://fetch.spec.whatwg.org/#redirect-status)).
38+
39+
This error is fixable and textlint will automatically replace the obsolete links with their new ones if you run it with `--fix` option.
40+
41+
### Relative Link Resolution
42+
43+
Sometimes your files contain relative URIs, which don't have domain information in an URI string.
44+
45+
You can enable availability checks to such links by telling the rule how to resolve the relative links (See below for details).
46+
2747
## Options
2848

2949
Please write your configurations in `.textlintrc`.
@@ -66,7 +86,7 @@ Example:
6686

6787
### ignore
6888

69-
An array of URIs to be ignored, i.e. skipped from availability checks.
89+
An array of URIs to be ignored. These URIs will be skipped from the availability checks.
7090

7191
Example:
7292

0 commit comments

Comments
 (0)