mdrefcheck 0.1.5__py3-none-musllinux_1_2_aarch64.whl → 0.1.7__py3-none-musllinux_1_2_aarch64.whl

mdrefcheck-0.1.7.dist-info/METADATA

@@ -0,0 +1,70 @@
+Metadata-Version: 2.4
+Name: mdrefcheck
+Version: 0.1.7
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Rust
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Documentation
+Classifier: Topic :: Software Development :: Quality Assurance
+Classifier: Topic :: Utilities
+License-File: LICENSE
+Summary: A CLI tool to validate references in markdown files.
+Home-Page: https://github.com/gospodima/mdrefcheck
+Author-email: gospodima <dimasc28@gmail.com>
+License-Expression: MIT
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
+Project-URL: Repository, https://github.com/gospodima/mdrefcheck
+
+# mdrefcheck
+
+[![PyPI version](https://img.shields.io/pypi/v/mdrefcheck.svg?logo=pypi&logoColor=white)](https://pypi.org/project/mdrefcheck/)
+[![crates.io version](https://img.shields.io/crates/v/mdrefcheck.svg?logo=rust&logoColor=white)](https://crates.io/crates/mdrefcheck)
+[![Build Status](https://github.com/gospodima/mdrefcheck/actions/workflows/ci.yml/badge.svg)](https://github.com/gospodima/mdrefcheck/actions/workflows/ci.yml)
+[![License](https://img.shields.io/badge/license-MIT-blue.svg)](./LICENSE)
+
+A CLI tool to validate references and links in Markdown files (CommonMark spec).  
+It helps to ensure that your documentation is free from broken section links, missing images or files.
+
+## Features
+
+- Validate local file paths in image and file references
+- Check section links against actual headings, following [GitHub Flavored Markdown (GFM)](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#section-links) rules, including cross-file references (e.g. `./subfolder/another-file.md#heading-link`)
+- Detect broken reference-style links
+- Basic email validation
+
+## Installation
+
+### Cargo
+
+```bash
+cargo install mdrefcheck
+```
+
+### PyPI
+
+```bash
+pip install mdrefcheck
+```
+
+or run it directly in an isolated environment, e.g., with `uvx`:
+
+```bash
+uvx mdrefcheck .
+```
+
+## Pre-commit integration
+
+Add this to your `.pre-commit-config.yaml`:
+
+```yaml
+repos:
+  - repo: https://github.com/gospodima/mdrefcheck
+    rev: v0.1.7
+    hooks:
+      - id: mdrefcheck
+```
+

mdrefcheck-0.1.7.dist-info/RECORD

@@ -0,0 +1,5 @@
+mdrefcheck-0.1.7.data/scripts/mdrefcheck,sha256=_Y8OxMfgkGuEATmUJJU8724UZyl72iqCc_9QWb1RjcY,3767872
+mdrefcheck-0.1.7.dist-info/METADATA,sha256=-2Dmf4mxUIrl86HPbL3QfkdsHWuGoF8KyGc3GdFRSEM,2380
+mdrefcheck-0.1.7.dist-info/WHEEL,sha256=R9voYWsoT2JH_cnrKT2ek3YkpDjFxvqcusFOIXl5uV4,105
+mdrefcheck-0.1.7.dist-info/licenses/LICENSE,sha256=yRPZLDTLTy8ybedkriMIVR7npEkOTqM2RSXdU_PsUew,1066
+mdrefcheck-0.1.7.dist-info/RECORD,,

mdrefcheck-0.1.5.dist-info/METADATA

@@ -1,45 +0,0 @@
-Metadata-Version: 2.4
-Name: mdrefcheck
-Version: 0.1.5
-Classifier: Development Status :: 4 - Beta
-Classifier: Environment :: Console
-Classifier: Intended Audience :: Developers
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Programming Language :: Rust
-Classifier: Programming Language :: Python :: 3
-Classifier: Topic :: Documentation
-Classifier: Topic :: Software Development :: Quality Assurance
-Classifier: Topic :: Utilities
-License-File: LICENSE
-Summary: A CLI tool to validate references in markdown files.
-Home-Page: https://github.com/gospodima/mdrefcheck
-Author-email: gospodima <dimasc28@gmail.com>
-License-Expression: MIT
-Requires-Python: >=3.7
-Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
-Project-URL: Repository, https://github.com/gospodima/mdrefcheck
-
-# mdrefcheck
-
-**mdrefcheck** is a CLI tool to validate references and links in Markdown files (CommonMark spec).  
-It helps ensure that your documentation is free from broken links, missing images, and invalid section anchors.
-
----
-
-## Features
-
-- Validate local file paths in image and section references
-- Check section links (`#heading-link`) match existing headings according to [GitHub Flavored Markdown (GFM)](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#section-links) rules
-- Identify broken reference-style links
-- Email validation
-
----
-
-## Installation
-
-From PyPI:
-
-```bash
-pip install mdrefcheck
-```
-

mdrefcheck-0.1.5.dist-info/RECORD

@@ -1,5 +0,0 @@
-mdrefcheck-0.1.5.data/scripts/mdrefcheck,sha256=spVOvEmmk6LUZUtcM4zCL_Ak-_KD4HqwQtIDU2ocUVM,3770176
-mdrefcheck-0.1.5.dist-info/METADATA,sha256=a51FnJUG6BppfjWAoFp_H6tr6TNeTKkUFOG-FjtWuBg,1520
-mdrefcheck-0.1.5.dist-info/WHEEL,sha256=R9voYWsoT2JH_cnrKT2ek3YkpDjFxvqcusFOIXl5uV4,105
-mdrefcheck-0.1.5.dist-info/licenses/LICENSE,sha256=yRPZLDTLTy8ybedkriMIVR7npEkOTqM2RSXdU_PsUew,1066
-mdrefcheck-0.1.5.dist-info/RECORD,,