Markdown-IT reader: A Plugin for Pelican
====================================================
[](https://github.com/gaige/markdown-it-reader/actions)
[](https://pypi.org/project/pelican-markdown-it-reader/)
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.
[existing issues]: https://github.com/gaige/markdown-it-reader/issues
[Contributing to Pelican]: https://docs.getpelican.com/en/latest/contribute.html
License
-------
This project is licensed under the MIT license.
Raw data
{
"_id": null,
"home_page": "https://github.com/gaige/markdown-it-reader",
"name": "pelican-markdown-it-reader",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.8",
"maintainer_email": null,
"keywords": "pelican, plugin",
"author": "Gaige B. Paulsen",
"author_email": "gaige@cluetrust.com",
"download_url": "https://files.pythonhosted.org/packages/15/9b/347fd20deb643558929b28fc2e05c2f58f9ddd996731b4e5d13b8c7ec0eb/pelican_markdown_it_reader-2.0.0.tar.gz",
"platform": null,
"description": "Markdown-IT reader: A Plugin for Pelican\n====================================================\n\n[](https://github.com/gaige/markdown-it-reader/actions)\n[](https://pypi.org/project/pelican-markdown-it-reader/)\n\n\nReader plugin for Markdown-IT-py replacement\n\nThis is double-opinionated, in that it's opinionated using Markdown-IT\nand again because we add in some additions; in particular:\n\n- Tables\n- footnotes\n- Pygment-based syntax highlighting\n\nInstallation\n------------\n\nThis plugin can be installed via:\n\n python -m pip install pelican-markdown-it-reader\n\n\nUsage\n-----\n\nThere are currently no configuration items.\n\nOnce installed it takes over responsibility for reading the following file extensions:\n\n - `md`\n - `markdown`\n - `mkd`\n - `mdown`\n\nBy taking over `link_open` and `image` render rules, the plugin handles replacing the\npelican link placeholders with appropriate `href` items which are then rendered to html.\n\nContributing\n------------\n\nContributions are welcome and much appreciated. Every little bit helps.\nYou can contribute by improving the documentation, adding missing features,\nand fixing bugs. You can also help out by reviewing and commenting on [existing issues][].\n\nTo start contributing to this plugin, review the [Contributing to Pelican][] documentation, beginning with the **Contributing Code** section.\n\n[existing issues]: https://github.com/gaige/markdown-it-reader/issues\n[Contributing to Pelican]: https://docs.getpelican.com/en/latest/contribute.html\n\nLicense\n-------\n\nThis project is licensed under the MIT license.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Reader plugin for Markdown-IT-py replacement",
"version": "2.0.0",
"project_urls": {
"Documentation": "https://docs.getpelican.com",
"Homepage": "https://github.com/gaige/markdown-it-reader",
"Issue Tracker": "https://github.com/gaige/markdown-it-reader/issues",
"Repository": "https://github.com/gaige/markdown-it-reader"
},
"split_keywords": [
"pelican",
" plugin"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d87a7129019bd1d16a7978dd94b2c1516a97e929728697254e669c3df17855be",
"md5": "7df817ae185bc843ff7ae6a000d83004",
"sha256": "6d1bfdec35d1313dfa734f88f0d51d8d7faa6d071c6442655f44670b3d0304d7"
},
"downloads": -1,
"filename": "pelican_markdown_it_reader-2.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "7df817ae185bc843ff7ae6a000d83004",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.8",
"size": 4397,
"upload_time": "2024-04-09T19:28:59",
"upload_time_iso_8601": "2024-04-09T19:28:59.851800Z",
"url": "https://files.pythonhosted.org/packages/d8/7a/7129019bd1d16a7978dd94b2c1516a97e929728697254e669c3df17855be/pelican_markdown_it_reader-2.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "159b347fd20deb643558929b28fc2e05c2f58f9ddd996731b4e5d13b8c7ec0eb",
"md5": "ce5fe285557c47ec433ae88bde5a3b9a",
"sha256": "36db693858da89f6ba991cc351ddd1c75a054151af0cb6a4c8dea552a8791abf"
},
"downloads": -1,
"filename": "pelican_markdown_it_reader-2.0.0.tar.gz",
"has_sig": false,
"md5_digest": "ce5fe285557c47ec433ae88bde5a3b9a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.8",
"size": 3993,
"upload_time": "2024-04-09T19:29:01",
"upload_time_iso_8601": "2024-04-09T19:29:01.516041Z",
"url": "https://files.pythonhosted.org/packages/15/9b/347fd20deb643558929b28fc2e05c2f58f9ddd996731b4e5d13b8c7ec0eb/pelican_markdown_it_reader-2.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-09 19:29:01",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "gaige",
"github_project": "markdown-it-reader",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "pelican-markdown-it-reader"
}
JSON
