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