NotAShelf/mdlinkt
1
0
Fork 0
mirror of https://github.com/NotAShelf/mdlinkt.git synced 2024-11-22 05:10:47 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

add usage and license information

Browse source
This commit is contained in:
raf 2023-12-24 22:15:51 +03:00
parent 3dd84414c3
commit a3ff066c29
No known key found for this signature in database
GPG key ID: 02D1DD3FA08B6B29
2 changed files with 39 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

BIN
.github/assets/demo.png vendored Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 18 KiB

39
README.md
View file

@ -1,3 +1,42 @@
# 🚨 mdlinkt
A CLI tool for detecting dead or inaccessible links in markdown files.
## Usage
To check a markdown file for dead or inaccessible links
```console
mdlinkt -file your-file.md
```
This will return each tested link and a summary message in an example markdown file containing 1 valid and 1 invalid file.
```console
mdlinkt -file test.md
2023/12/12 12:00:00 ERROR Invalid link: https://probablynotvalid.com
2023/12/12 12:00:00 INFO Summary: 1 valid links, 1 invalid links
```
Should you want more details on the links that are scanned, you may pass the `-verbose` flag.
```console
2023/12/12 12:00:00 INFO https://github.com: 200
2023/12/12 12:00:00 ERROR Invalid link: https://probablynotvalid.com
2023/12/12 12:00:00 INFO Summary: 1 valid links, 1 invalid links
```
In case of invalid links, the program will exit with exit code 1, making it perfect for usage in
GitHub actions or other pipelines.
## Hacking
A nix flake is provided. Use `direnv allow` or `nix develop` to enter the development shell.
### Contributing
PRs are always welcome.
## License
**mdlinkt** is licensed under the GPLv3. See [LICENSE](LICENSE) for more details.