Skip to content

Commit 4ee94e8

Browse files
Merge pull request #108 from UmbrellaDocs/version-update
Chore: version and README updates
2 parents 89e9bc3 + 4fca81c commit 4ee94e8

File tree

2 files changed

+13
-7
lines changed

2 files changed

+13
-7
lines changed

README.md

+4-5
Original file line numberDiff line numberDiff line change
@@ -291,11 +291,10 @@ useGitIgnore: true
291291

292292
## Sample output
293293

294-
If there are failed links, linkspector shows the output as comma-seprated values and exit with error.
295-
`File, HTTP status code, Line number, Error message`
294+
If there are failed links, linkspector shows the output with detailed information in `errorformat`. For example:
296295

297296
```
298-
REDISTRIBUTED.md, https://unlicense.org/, null, 186, net::ERR_SSL_VERSION_OR_CIPHER_MISMATCH at https://unlicense.org/]
297+
test/fixtures/markdown/relative/relative1.md:23:1: 🚫 relative3.md#relative-3-heading-level-one Status:404 Cannot find: relative3.md#relative-3-heading-level-one test/fixtures/markdown/relative/relative1.md:27:1: 🚫 #broken-section Status:404 Cannot find section: #broken-section in file: test/fixtures/markdown/relative/relative1.md. test/fixtures/markdown/duplicates/duplicate1.md:3:19: 🚫 https://www.yahoo434234esdsadasd.com Status:null net::ERR_NAME_NOT_RESOLVED at https://www.yahoo434234esdsadasd.com test/fixtures/markdown/duplicates/duplicate1.md:7:19: 🚫 https://www.yahoo434234esdsadasd.com Status:null net::ERR_NAME_NOT_RESOLVED at https://www.yahoo434234esdsadasd.com
299298
💥 Error: Some hyperlinks in the specified files are invalid.
300299
```
301300

@@ -314,13 +313,13 @@ To use Linkspector with Docker, follow these steps:
314313
git clone [email protected]:UmbrellaDocs/linkspector.git
315314
cd linkspector
316315
```
317-
1. Build the docker image locally, while being at the root (`.`) of this project:
316+
2. Build the docker image locally, while being at the root (`.`) of this project:
318317

319318
```bash
320319
docker build --no-cache --pull --build-arg LINKSPECTOR_PACKAGE= -t umbrelladocs/linkspector .
321320
```
322321

323-
1. To perform a check using the default configuration, while being at the root (`$PWD`) of the project to be checked:
322+
3. To perform a check using the default configuration, while being at the root (`$PWD`) of the project to be checked:
324323

325324
```bash
326325
docker run --rm -it -v $PWD:/app \

package.json

+9-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@umbrelladocs/linkspector",
3-
"version": "0.3.13",
3+
"version": "0.4.0",
44
"description": "Uncover broken links in your content.",
55
"type": "module",
66
"main": "linkspector.js",
@@ -24,7 +24,14 @@
2424
"markdown link testing tool",
2525
"markdown link check",
2626
"markdown link checker",
27-
"markdown link validation"
27+
"markdown link validation",
28+
"markdown link verification",
29+
"asciidoc link testing",
30+
"asciidoc link testing tool",
31+
"asciidoc link check",
32+
"asciidoc link checker",
33+
"asciidoc link validation",
34+
"asciidoc link verification"
2835
],
2936
"bin": {
3037
"linkspector": "./index.js"

0 commit comments

Comments
 (0)