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.

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

Uploaded Source

Built Distribution

File details

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

File metadata

File hashes

Hashes for pelican_markdown_it_reader-2.0.2.tar.gz
Algorithm Hash digest
SHA256 ad5184eeaa4105b204dd106631547a57476ae658425a6c698512d021d31c93fb
MD5 0cce7c0f2dd6888656ff67feef454fc5
BLAKE2b-256 d49245a695de49f66ac6de6c145bb2b5743c49f4e8a2b0f64c722bba2aa7f74a

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for pelican_markdown_it_reader-2.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 57aecfb9888f511dc0141b72530569015381a2bc77ac5db9e34240b91b0ee888
MD5 696d92afc259d98ad5b54ac928ac30fc
BLAKE2b-256 07b90096050dc1749d6867fef68d066f57e8cbbc0616895914e37960d87d032d

See more details on using hashes here.

Supported by

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