1.0.1 • Published 1 year ago

@marifervl/md-links v1.0.1

Weekly downloads
-
License
ISC
Repository
-
Last release
1 year ago

Author María-Fernanda Villalobos

Index


1. About the project

Programming language

2. Installation

npm install @marifervl/md-links

3. Usage

md-links <path> [options]

Where <path> is the absolute or relative path to the file or directory to analyze, and [options] are additional options that can be used to customize the output.

Options:

--validate

--stats

--validate --stats

Usage examples

Prints to the console the links found in the file file.md, along with the file path where each link was found and the text that appears within the link.

md-links directory/

Analyzes all Markdown files within the directory directory/ and its subdirectories, and prints to the console the links found.

md-links file.md --validate

Prints to the console the links found in the file file.md, along with the file path where each link was found, the text that appears within the link, and the status of the HTTP response received when making an HTTP request.

md-links file.md --stats

Prints to the console basic statistics about the links found in the file file.md, including the total number of links found and the number of unique links.

md-links file.md --validate --stats

Prints to the console statistics about the links found in the file file.md, including the total number of links found, the number of unique links, and the number of broken links.

https://user-images.githubusercontent.com/99364311/235831788-c529e3a2-a2df-4d7d-86e9-ad411cbb323a.mp4

5. Contribution

6. License

7. References

1.0.1

1 year ago

1.0.0

1 year ago