Metadata-Version: 2.4
Name: linkstat
Version: 1.0.2
Summary: Perform connectivity checks on URLs listed in the Markdown
Project-URL: Repository, https://github.com/DogFortune/linkstat
Project-URL: Issues, https://github.com/DogFortune/linkstat/issues
Project-URL: Changelog, https://github.com/DogFortune/linkstat/releases
Author-email: DogFortune <dogfortune.2000@gmail.com>
License-File: LICENSE
Keywords: check,link,url
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Topic :: Documentation
Classifier: Topic :: Internet
Requires-Python: >=3.10
Requires-Dist: dataclasses-json
Description-Content-Type: text/markdown

# linkstat
[![test-lint-format](https://github.com/DogFortune/linkstat/actions/workflows/lint-test-format.yml/badge.svg?branch=main)](https://github.com/DogFortune/linkstat/actions) [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)

_linkstat_ is a script that verifies the connectivity of links documented in the documentation. By detecting broken links early, it maintains the integrity of the documentation.  
Currently, only Markdown files (*.md) are supported.

## Caution
This library accesses services during runtime, so executing it in large quantities will cause load on the target service. When performing functional verification or integrating into CI/CD, please ensure the load on the linked service is minimized as much as possible.

## Install

```sh
pip install linkstat
```

## Usage

```sh
linkstat {source_file_or_directory}
```

## Output

You can output reports in JSON format by using the option.

```sh
linkstat --report-json {path} {source_file_or_directory}
```

## Contribute
[Guideline](CONTRIBUTING.md)