Reader plugin for Markdown-IT-py replacement

Navigation

Verified details

These details have been verified by PyPI
Project links
GitHub Statistics
Maintainers
Avatar for gaige from gravatar.com gaige

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: MIT License (MIT)
  • Author: Gaige B. Paulsen
  • Tags pelican , plugin
  • Requires: Python <4.0, >=3.8
  • Provides-Extra: markdown
Classifiers
Report project as malware

Project description

Markdown-IT reader: A Plugin for Pelican

Build Status PyPI Version License

Reader plugin for Markdown-IT-py replacement

This is double-opinionated, in that it's opinionated using Markdown-IT and again because we add in some additions; in particular:

  • Tables
  • footnotes
  • Pygment-based syntax highlighting

Installation

This plugin can be installed via:

python -m pip install pelican-markdown-it-reader

Usage

There are currently no configuration items.

Once installed it takes over responsibility for reading the following file extensions:

  • md
  • markdown
  • mkd
  • mdown

By taking over link_open and image render rules, the plugin handles replacing the pelican link placeholders with appropriate href items which are then rendered to html.

Contributing

Contributions are welcome and much appreciated. Every little bit helps. You can contribute by improving the documentation, adding missing features, and fixing bugs. You can also help out by reviewing and commenting on existing issues.

To start contributing to this plugin, review the Contributing to Pelican documentation, beginning with the Contributing Code section.

Updating

We use dependabot for updating dependencies, conventional commits for commit messages, and github actions for release.

To generate a release:

  1. cz bump --dry-run [--increment patch] to verify changes
  2. cz bump [--increment patch] to finalize
  3. git push to send code and git push <tag> to send the tag (or the less-safe --tags)

License

This project is licensed under the MIT license.

Project details

Verified details

These details have been verified by PyPI
Project links
GitHub Statistics
Maintainers
Avatar for gaige from gravatar.com gaige

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: MIT License (MIT)
  • Author: Gaige B. Paulsen
  • Tags pelican , plugin
  • Requires: Python <4.0, >=3.8
  • Provides-Extra: markdown
Classifiers

Release history Release notifications | RSS feed

This version

2.0.4

2.0.3

2.0.2

2.0.1

2.0.0

1.0.1

1.0.0

0.2.0

0.1.0

0.0.3

0.0.2

0.0.1

Download files

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

Source Distribution

pelican_markdown_it_reader-2.0.4.tar.gz (4.0 kB view details)

Uploaded Source

Built Distribution

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

pelican_markdown_it_reader-2.0.4-py3-none-any.whl (4.6 kB view details)

Uploaded Python 3

File details

Details for the file pelican_markdown_it_reader-2.0.4.tar.gz.

File metadata

File hashes

Hashes for pelican_markdown_it_reader-2.0.4.tar.gz
Algorithm Hash digest
SHA256 75113e2e0bc33bcd7ade06eca79f921dfc08fa5f93d1077412aeaa2084b318f4
MD5 1148b511ea4c0f2a9e358d1056783b72
BLAKE2b-256 a9b93478e76fe0b1f1c0243d660626e95816a2543c40277cf60896b6f9ddaba6

See more details on using hashes here.

Provenance

The following attestation bundles were made for pelican_markdown_it_reader-2.0.4.tar.gz:

Publisher: main.yml on gaige/markdown-it-reader

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file pelican_markdown_it_reader-2.0.4-py3-none-any.whl.

File metadata

File hashes

Hashes for pelican_markdown_it_reader-2.0.4-py3-none-any.whl
Algorithm Hash digest
SHA256 de0b504cd1ae1aaa5d038dc92b6c3057d32d328aeb5af9aa4e007b0dc8d37403
MD5 27126a77df25c1d0f5b691a67449189a
BLAKE2b-256 ae9db727d3fab496628c544ddb4a5fffe15e19687ae0ee91f04361055f3c7e1f

See more details on using hashes here.

Provenance

The following attestation bundles were made for pelican_markdown_it_reader-2.0.4-py3-none-any.whl:

Publisher: main.yml on gaige/markdown-it-reader

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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