Metadata-Version: 2.1
Name: md-url-check
Version: 0.1.0
Summary: Simple CLI tool to check URL health in markdown files.
Home-page: https://github.com/rednafi/md-url-check
License: MIT
Keywords: python,markdown,url,command-line
Author: Redowan Delowar
Author-email: redowan.nafi@gmail.com
Requires-Python: >=3.9,<4.0
Classifier: Environment :: Console
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Software Development
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Software Development :: Quality Assurance
Project-URL: Repository, https://github.com/rednafi/md-url-check
Description-Content-Type: text/markdown

<div align="center">

<h1>Markdown URL Checker</h1>
<strong>>> <i>Simple CLI tool to check URL health in markdown files</i> <<</strong>

&nbsp;

![img](./art/logo.png)

</div>


## Installation

Install the CLI using pip.

```
pip install md-url-checker
```


## Usage


* To check the URLs in a single markdown file, run:

    ```
    md-url-check -f file.md
    ```

* To check the URLs in multiple markdown files, run:

    ```
    echo 'file1.md file2.md' | xargs -n 1 md-url-check -f
    ```

* To check the URLs in multiple files in a folder, run:

    ```
    find . -name '*.md' | xargs -n 1 --no-run-if-empty md-url-check -f
    ```

