# mdformat-plugin
[](https://github.com/gaige/mdformat-pelican/actions)
[](https://pypi.org/project/mdformat_pelican/)
An [mdformat](https://github.com/executablebooks/mdformat) plugin for the pelican static site generator.
[Pelican](https://getpelican.com) is a static site generator and uses markdown with a couple of additions,
namely skipping the K:V pairs at the start and the ability to reference:
- tag
- author
- category
- index
- filename
- static
- attach
Note that the `{name}` forms are supported, and the `|name|` forms are converted to the newer form,
as the pipe form has been deprecated.
## Development
This package utilises [flit](https://flit.readthedocs.io) as the build engine, and [tox](https://tox.readthedocs.io) for test automation.
To install these development dependencies:
```bash
pip install tox
```
To run the tests:
```bash
tox
```
and with test coverage:
```bash
tox -e py311-cov
```
The easiest way to write tests, is to edit tests/fixtures.md
To run the code formatting and style checks:
```bash
tox -e py311-pre-commit
```
or directly
```bash
pip install pre-commit
pre-commit run --all
```
To run the pre-commit hook test:
```bash
tox -e py311-hook
```
## Publish to PyPi
Either use flit directly:
```bash
pip install flit
flit publish
```
or trigger the GitHub Action job, by creating a release with a tag equal to the version, e.g. `v0.0.1`.
Raw data
{
"_id": null,
"home_page": "https://github.com/gaige/mdformat-pelican",
"name": "mdformat-pelican",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": "mdformat, markdown, markdown-it",
"author": "Gaige B. Paulsen",
"author_email": "gaige@cluetrust.com",
"download_url": "https://files.pythonhosted.org/packages/41/63/839c2fd7dae0305e82e46b6d35162f7546de9adaa34a2ab8731f9eb02c66/mdformat_pelican-0.2.1.tar.gz",
"platform": null,
"description": "# mdformat-plugin\n\n[](https://github.com/gaige/mdformat-pelican/actions)\n[](https://pypi.org/project/mdformat_pelican/)\n\n\nAn [mdformat](https://github.com/executablebooks/mdformat) plugin for the pelican static site generator.\n[Pelican](https://getpelican.com) is a static site generator and uses markdown with a couple of additions,\nnamely skipping the K:V pairs at the start and the ability to reference:\n\n- tag\n- author\n- category\n- index\n- filename\n- static\n- attach\n\nNote that the `{name}` forms are supported, and the `|name|` forms are converted to the newer form,\nas the pipe form has been deprecated.\n\n\n## Development\n\nThis package utilises [flit](https://flit.readthedocs.io) as the build engine, and [tox](https://tox.readthedocs.io) for test automation.\n\nTo install these development dependencies:\n\n```bash\npip install tox\n```\n\nTo run the tests:\n\n```bash\ntox\n```\n\nand with test coverage:\n\n```bash\ntox -e py311-cov\n```\n\nThe easiest way to write tests, is to edit tests/fixtures.md\n\nTo run the code formatting and style checks:\n\n```bash\ntox -e py311-pre-commit\n```\n\nor directly\n\n```bash\npip install pre-commit\npre-commit run --all\n```\n\nTo run the pre-commit hook test:\n\n```bash\ntox -e py311-hook\n```\n\n## Publish to PyPi\n\nEither use flit directly:\n\n```bash\npip install flit\nflit publish\n```\n\nor trigger the GitHub Action job, by creating a release with a tag equal to the version, e.g. `v0.0.1`.\n\n",
"bugtrack_url": null,
"license": null,
"summary": "An mdformat plugin for pelican markdown items",
"version": "0.2.1",
"project_urls": {
"Homepage": "https://github.com/gaige/mdformat-pelican"
},
"split_keywords": [
"mdformat",
" markdown",
" markdown-it"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "0f180537278cb7cc2a92ffd28a48615b9983b0e77fd88fccc28462b425268d00",
"md5": "e6c4c6ade247ee905492d1d454f4fa48",
"sha256": "771249cec53404b53187f4b555bf24593dc70be07795e38223570c9f986ac822"
},
"downloads": -1,
"filename": "mdformat_pelican-0.2.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e6c4c6ade247ee905492d1d454f4fa48",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 4304,
"upload_time": "2024-06-29T17:52:35",
"upload_time_iso_8601": "2024-06-29T17:52:35.739203Z",
"url": "https://files.pythonhosted.org/packages/0f/18/0537278cb7cc2a92ffd28a48615b9983b0e77fd88fccc28462b425268d00/mdformat_pelican-0.2.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "4163839c2fd7dae0305e82e46b6d35162f7546de9adaa34a2ab8731f9eb02c66",
"md5": "51d581e10326aa4d49e1b579bd635974",
"sha256": "0fdff5fddb0822c85b6f358ba743cf32dcd717e0493b42bd375a12d4762113fc"
},
"downloads": -1,
"filename": "mdformat_pelican-0.2.1.tar.gz",
"has_sig": false,
"md5_digest": "51d581e10326aa4d49e1b579bd635974",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 3752,
"upload_time": "2024-06-29T17:52:36",
"upload_time_iso_8601": "2024-06-29T17:52:36.759958Z",
"url": "https://files.pythonhosted.org/packages/41/63/839c2fd7dae0305e82e46b6d35162f7546de9adaa34a2ab8731f9eb02c66/mdformat_pelican-0.2.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-29 17:52:36",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "gaige",
"github_project": "mdformat-pelican",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"tox": true,
"lcname": "mdformat-pelican"
}
JSON
