mdrefcheck 0.1.5__py3-none-manylinux_2_17_s390x.manylinux2014_s390x.whl → 0.1.6__py3-none-manylinux_2_17_s390x.manylinux2014_s390x.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 (6) hide show
  1. {mdrefcheck-0.1.5.data → mdrefcheck-0.1.6.data}/scripts/mdrefcheck +0 -0
  2. {mdrefcheck-0.1.5.dist-info → mdrefcheck-0.1.6.dist-info}/METADATA +35 -8
  3. mdrefcheck-0.1.6.dist-info/RECORD +5 -0
  4. mdrefcheck-0.1.5.dist-info/RECORD +0 -5
  5. {mdrefcheck-0.1.5.dist-info → mdrefcheck-0.1.6.dist-info}/WHEEL +0 -0
  6. {mdrefcheck-0.1.5.dist-info → mdrefcheck-0.1.6.dist-info}/licenses/LICENSE +0 -0
{mdrefcheck-0.1.5.dist-info → mdrefcheck-0.1.6.dist-info}/METADATA RENAMED
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: mdrefcheck
3
- Version: 0.1.5
3
+ Version: 0.1.6
4
4
  Classifier: Development Status :: 4 - Beta
5
5
  Classifier: Environment :: Console
6
6
  Classifier: Intended Audience :: Developers
@@ -21,10 +21,8 @@ Project-URL: Repository, https://github.com/gospodima/mdrefcheck
21
21
 
22
22
  # mdrefcheck
23
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
- ---
24
+ A CLI tool to validate references and links in Markdown files (CommonMark spec).
25
+ It helps to ensure that your documentation is free from broken section links, missing images or files.
28
26
 
29
27
  ## Features
30
28
 
@@ -33,13 +31,42 @@ It helps ensure that your documentation is free from broken links, missing image
33
31
  - Identify broken reference-style links
34
32
  - Email validation
35
33
 
36
- ---
37
-
38
34
  ## Installation
39
35
 
40
- From PyPI:
36
+ ### Cargo
37
+
38
+ `mdrefcheck` is also published on [crates.io](https://crates.io/) and can be installed
39
+ with cargo:
40
+
41
+ ```bash
42
+ cargo install mdrefcheck
43
+ ```
44
+
45
+ ### PyPI
46
+
47
+ `mdrefcheck` can be installed with
41
48
 
42
49
  ```bash
43
50
  pip install mdrefcheck
44
51
  ```
45
52
 
53
+ It also can be used as a tool in an isolated environment, e.g., with `uvx`:
54
+
55
+ ```bash
56
+ uvx mdrefcheck .
57
+ ```
58
+
59
+ ### Pre-commit integration
60
+
61
+ You can use `mdrefcheck` as a pre-commit hook.
62
+
63
+ Add this to your `.pre-commit-config.yaml`:
64
+
65
+ ```yaml
66
+ repos:
67
+ - repo: https://github.com/gospodima/mdrefcheck
68
+ rev: v0.1.6
69
+ hooks:
70
+ - id: mdrefcheck
71
+ ```
72
+
mdrefcheck-0.1.6.dist-info/RECORD ADDED
@@ -0,0 +1,5 @@
1
+ mdrefcheck-0.1.6.data/scripts/mdrefcheck,sha256=VR4Dc5vEt10VR5_JG7budF4Y8xFa8DgMlh4UD8FBwcc,4163872
2
+ mdrefcheck-0.1.6.dist-info/METADATA,sha256=ITQ_-SwjqcwFfynA9LVRksHKUmGARDpYRsKbDxA7lNU,2015
3
+ mdrefcheck-0.1.6.dist-info/WHEEL,sha256=MSMEYa2KXx4tE3dgRxGI2fu-mfARMjDDhGhIVEKSm2g,124
4
+ mdrefcheck-0.1.6.dist-info/licenses/LICENSE,sha256=yRPZLDTLTy8ybedkriMIVR7npEkOTqM2RSXdU_PsUew,1066
5
+ mdrefcheck-0.1.6.dist-info/RECORD,,
mdrefcheck-0.1.5.dist-info/RECORD DELETED
@@ -1,5 +0,0 @@
1
- mdrefcheck-0.1.5.data/scripts/mdrefcheck,sha256=27zrHjLh11S9CWi_fLkbu334EJHKLGI3-w1CLQ64rlY,4163912
2
- mdrefcheck-0.1.5.dist-info/METADATA,sha256=a51FnJUG6BppfjWAoFp_H6tr6TNeTKkUFOG-FjtWuBg,1520
3
- mdrefcheck-0.1.5.dist-info/WHEEL,sha256=MSMEYa2KXx4tE3dgRxGI2fu-mfARMjDDhGhIVEKSm2g,124
4
- mdrefcheck-0.1.5.dist-info/licenses/LICENSE,sha256=yRPZLDTLTy8ybedkriMIVR7npEkOTqM2RSXdU_PsUew,1066
5
- mdrefcheck-0.1.5.dist-info/RECORD,,