mdrefcheck 0.1.1__py3-none-musllinux_1_2_aarch64.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.
|
Binary file
|
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: mdrefcheck
|
|
3
|
+
Version: 0.1.1
|
|
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://gitlab.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://gitlab.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
|
+
|
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
mdrefcheck-0.1.1.data/scripts/mdrefcheck,sha256=pn89BXnaCIX5WGiHZ3Qmbp4_cIoxkC2O5RHh6AKtK9g,3770144
|
|
2
|
+
mdrefcheck-0.1.1.dist-info/METADATA,sha256=tKp9IF5F78_PWzqcE4gFNE7VzoiGDpX5dxUqKVUwW1s,1520
|
|
3
|
+
mdrefcheck-0.1.1.dist-info/WHEEL,sha256=R9voYWsoT2JH_cnrKT2ek3YkpDjFxvqcusFOIXl5uV4,105
|
|
4
|
+
mdrefcheck-0.1.1.dist-info/licenses/LICENSE,sha256=yRPZLDTLTy8ybedkriMIVR7npEkOTqM2RSXdU_PsUew,1066
|
|
5
|
+
mdrefcheck-0.1.1.dist-info/RECORD,,
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2025 gospodima
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|