Skip to main content

Reader plugin for Markdown-IT-py replacement

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


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.3.tar.gz (4.2 kB view details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for pelican_markdown_it_reader-2.0.3.tar.gz
Algorithm Hash digest
SHA256 a557a8261d36c298ba21d8a227708093e4959eeb97c8c193d560610b3ca2c738
MD5 d1f59f390e5c1d16929ff8e569fd2d15
BLAKE2b-256 65fc2172e8d3b3a158b76ebd92ec213123c961bb164a74e13479ea2d83062d10

See more details on using hashes here.

Provenance

The following attestation bundles were made for pelican_markdown_it_reader-2.0.3.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.3-py3-none-any.whl.

File metadata

File hashes

Hashes for pelican_markdown_it_reader-2.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 6fb2175a8a9b971eedf459f448164bba7e5bc24dc79ddf6b2d8a9ae2a71f0ab1
MD5 fdc35c63df4cc7ab36790e0afb5e8628
BLAKE2b-256 551c994e3bafdbfa011f3509621506ec8ac5a5df08aa7446b7f15382153a55fb

See more details on using hashes here.

Provenance

The following attestation bundles were made for pelican_markdown_it_reader-2.0.3-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 Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page