Skip to main content

A Python wrapper around jackdewinter's PyMarkdown linter to suppress errors, caused by custom-formatted tables in Markdown files

This project has been archived.

The maintainers of this project have marked this project as archived. No new releases are expected.

Project description

CCFT-PyMarkdown

CCFT-PyMarkdown PyPI Version Python Version PyMarkdown Version Tests Status mypy Status Ruff uv

A Python wrapper around jackdewinter's PyMarkdown linter to suppress errors, caused by custom-formatted tables in Markdown files

When running PyMarkdown it may incorrectly flag errors inside a table that has correct formatting. Using this wrapper, the errors will be suppressed by temporarily cleaning any custom-formatted tables.

Usage

If you require sending additional arguments to the pymarkdown command you must manually clean any custom-formatted tables and then manually restore the MarkDown files.

Scanning All Files After Cleaning Custom-Formatted Tables

To perform linting using PyMarkdown, after cleaning custom-formatted tables within any MarkDown files, use the scan-all action:

ccft-pymarkdown scan-all

Manually Cleaning Custom-Formatted Tables

To manually clean custom-formatted-tables within any MarkDown files without running PyMarkdown, use the clean action:

ccft-pymarkdown clean

Manually Restoring https://wikipedia.org/wiki/Markdown[MarkDown] Files

To manually restore any MarkDown files without running PyMarkdown, use the restore action:

ccft-pymarkdown restore

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ccft_pymarkdown-2.0.0.tar.gz (15.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

ccft_pymarkdown-2.0.0-py3-none-any.whl (17.0 kB view details)

Uploaded Python 3

File details

Details for the file ccft_pymarkdown-2.0.0.tar.gz.

File metadata

  • Download URL: ccft_pymarkdown-2.0.0.tar.gz
  • Upload date:
  • Size: 15.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.5.14

File hashes

Hashes for ccft_pymarkdown-2.0.0.tar.gz
Algorithm Hash digest
SHA256 4845f6b4e6dee26d01edf103b5fcc212b9e231a967ff12e25f572f8b73afcee7
MD5 fc9c57d8f7f8e7e60912c69df9914279
BLAKE2b-256 0252ae29a9172095d04c2870bd43337e3f84a2b7a29b95edaa7ee9a0e4b0f053

See more details on using hashes here.

File details

Details for the file ccft_pymarkdown-2.0.0-py3-none-any.whl.

File metadata

File hashes

Hashes for ccft_pymarkdown-2.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 bbafba740da3c8d437266df41d4dce700c4406c6cdf4112e59a8d4250c37c3fd
MD5 5736126d0984e3b56bd0d7a844c0d122
BLAKE2b-256 d41eb4c1703b2e5048fb07271e90fb8628de1ec9a5d4444e4039ce888b5e23bd

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page