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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Potentially problematic release.

This version of mdrefcheck might be problematic. Click here for more details.

Files changed (8) hide show
  1. mdrefcheck-0.1.7.data/scripts/mdrefcheck.exe +0 -0
  2. mdrefcheck-0.1.7.dist-info/METADATA +70 -0
  3. mdrefcheck-0.1.7.dist-info/RECORD +5 -0
  4. mdrefcheck-0.1.5.data/scripts/mdrefcheck.exe +0 -0
  5. mdrefcheck-0.1.5.dist-info/METADATA +0 -45
  6. mdrefcheck-0.1.5.dist-info/RECORD +0 -5
  7. {mdrefcheck-0.1.5.dist-info → mdrefcheck-0.1.7.dist-info}/WHEEL +0 -0
  8. {mdrefcheck-0.1.5.dist-info → mdrefcheck-0.1.7.dist-info}/licenses/LICENSE +0 -0
mdrefcheck-0.1.7.dist-info/METADATA ADDED
@@ -0,0 +1,70 @@
1
+ Metadata-Version: 2.4
2
+ Name: mdrefcheck
3
+ Version: 0.1.7
4
+ Classifier: Development Status :: 4 - Beta
5
+ Classifier: Environment :: Console
6
+ Classifier: Intended Audience :: Developers
7
+ Classifier: License :: OSI Approved :: MIT License
8
+ Classifier: Programming Language :: Rust
9
+ Classifier: Programming Language :: Python :: 3
10
+ Classifier: Topic :: Documentation
11
+ Classifier: Topic :: Software Development :: Quality Assurance
12
+ Classifier: Topic :: Utilities
13
+ License-File: LICENSE
14
+ Summary: A CLI tool to validate references in markdown files.
15
+ Home-Page: https://github.com/gospodima/mdrefcheck
16
+ Author-email: gospodima <dimasc28@gmail.com>
17
+ License-Expression: MIT
18
+ Requires-Python: >=3.7
19
+ Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
20
+ Project-URL: Repository, https://github.com/gospodima/mdrefcheck
21
+
22
+ # mdrefcheck
23
+
24
+ [![PyPI version](https://img.shields.io/pypi/v/mdrefcheck.svg?logo=pypi&logoColor=white)](https://pypi.org/project/mdrefcheck/)
25
+ [![crates.io version](https://img.shields.io/crates/v/mdrefcheck.svg?logo=rust&logoColor=white)](https://crates.io/crates/mdrefcheck)
26
+ [![Build Status](https://github.com/gospodima/mdrefcheck/actions/workflows/ci.yml/badge.svg)](https://github.com/gospodima/mdrefcheck/actions/workflows/ci.yml)
27
+ [![License](https://img.shields.io/badge/license-MIT-blue.svg)](./LICENSE)
28
+
29
+ A CLI tool to validate references and links in Markdown files (CommonMark spec).
30
+ It helps to ensure that your documentation is free from broken section links, missing images or files.
31
+
32
+ ## Features
33
+
34
+ - Validate local file paths in image and file references
35
+ - 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`)
36
+ - Detect broken reference-style links
37
+ - Basic email validation
38
+
39
+ ## Installation
40
+
41
+ ### Cargo
42
+
43
+ ```bash
44
+ cargo install mdrefcheck
45
+ ```
46
+
47
+ ### PyPI
48
+
49
+ ```bash
50
+ pip install mdrefcheck
51
+ ```
52
+
53
+ or run it directly in an isolated environment, e.g., with `uvx`:
54
+
55
+ ```bash
56
+ uvx mdrefcheck .
57
+ ```
58
+
59
+ ## Pre-commit integration
60
+
61
+ Add this to your `.pre-commit-config.yaml`:
62
+
63
+ ```yaml
64
+ repos:
65
+ - repo: https://github.com/gospodima/mdrefcheck
66
+ rev: v0.1.7
67
+ hooks:
68
+ - id: mdrefcheck
69
+ ```
70
+
mdrefcheck-0.1.7.dist-info/RECORD ADDED
@@ -0,0 +1,5 @@
1
+ mdrefcheck-0.1.7.data/scripts/mdrefcheck.exe,sha256=w23NyLD5Mg6sXotvD_tPhHFmGe26VJqrgVKE6a-lG1U,2173440
2
+ mdrefcheck-0.1.7.dist-info/METADATA,sha256=TqDrJyCp15sREBehnQu-eT_XAT0Fs2cfEt5wq1-Fq3w,2428
3
+ mdrefcheck-0.1.7.dist-info/WHEEL,sha256=uT4IaxTLAwDsS7H6Z9jQmlZsLccZQ2CCUpoUS6OYuwI,89
4
+ mdrefcheck-0.1.7.dist-info/licenses/LICENSE,sha256=4xbeaKfLWZn51PYDdxgZUU3RzOszuGrYAuKvAh5ZK3U,1087
5
+ mdrefcheck-0.1.7.dist-info/RECORD,,
mdrefcheck-0.1.5.dist-info/METADATA DELETED
@@ -1,45 +0,0 @@
1
- Metadata-Version: 2.4
2
- Name: mdrefcheck
3
- Version: 0.1.5
4
- Classifier: Development Status :: 4 - Beta
5
- Classifier: Environment :: Console
6
- Classifier: Intended Audience :: Developers
7
- Classifier: License :: OSI Approved :: MIT License
8
- Classifier: Programming Language :: Rust
9
- Classifier: Programming Language :: Python :: 3
10
- Classifier: Topic :: Documentation
11
- Classifier: Topic :: Software Development :: Quality Assurance
12
- Classifier: Topic :: Utilities
13
- License-File: LICENSE
14
- Summary: A CLI tool to validate references in markdown files.
15
- Home-Page: https://github.com/gospodima/mdrefcheck
16
- Author-email: gospodima <dimasc28@gmail.com>
17
- License-Expression: MIT
18
- Requires-Python: >=3.7
19
- Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
20
- Project-URL: Repository, https://github.com/gospodima/mdrefcheck
21
-
22
- # mdrefcheck
23
-
24
- **mdrefcheck** is a CLI tool to validate references and links in Markdown files (CommonMark spec).
25
- It helps ensure that your documentation is free from broken links, missing images, and invalid section anchors.
26
-
27
- ---
28
-
29
- ## Features
30
-
31
- - Validate local file paths in image and section references
32
- - 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
33
- - Identify broken reference-style links
34
- - Email validation
35
-
36
- ---
37
-
38
- ## Installation
39
-
40
- From PyPI:
41
-
42
- ```bash
43
- pip install mdrefcheck
44
- ```
45
-
mdrefcheck-0.1.5.dist-info/RECORD DELETED
@@ -1,5 +0,0 @@
1
- mdrefcheck-0.1.5.data/scripts/mdrefcheck.exe,sha256=_sNUgs2xeXxdmFxw1FgzBTOsypKpt-s9M8fSSYmqGdI,2171904
2
- mdrefcheck-0.1.5.dist-info/METADATA,sha256=aF_nxNHeBHyjwXOSj7gy63yyS-PDTVcMIOvPpYVrlNo,1543
3
- mdrefcheck-0.1.5.dist-info/WHEEL,sha256=uT4IaxTLAwDsS7H6Z9jQmlZsLccZQ2CCUpoUS6OYuwI,89
4
- mdrefcheck-0.1.5.dist-info/licenses/LICENSE,sha256=4xbeaKfLWZn51PYDdxgZUU3RzOszuGrYAuKvAh5ZK3U,1087
5
- mdrefcheck-0.1.5.dist-info/RECORD,,