Name | markdown-pycon JSON |
Version |
1.0.1
JSON |
| download |
home_page | None |
Summary | Markdown extension to parse `pycon` code blocks without indentation or fences. |
upload_time | 2025-01-10 01:05:22 |
maintainer | None |
docs_url | None |
author | None |
requires_python | >=3.9 |
license | ISC |
keywords |
|
VCS |
|
bugtrack_url |
|
requirements |
No requirements were recorded.
|
Travis-CI |
No Travis.
|
coveralls test coverage |
No coveralls.
|
# Markdown PyCon
[![ci](https://github.com/pawamoy/markdown-pycon/workflows/ci/badge.svg)](https://github.com/pawamoy/markdown-pycon/actions?query=workflow%3Aci)
[![documentation](https://img.shields.io/badge/docs-mkdocs-708FCC.svg?style=flat)](https://pawamoy.github.io/markdown-pycon/)
[![pypi version](https://img.shields.io/pypi/v/markdown-pycon.svg)](https://pypi.org/project/markdown-pycon/)
[![gitter](https://badges.gitter.im/join%20chat.svg)](https://app.gitter.im/#/room/#markdown-pycon:gitter.im)
Markdown extension to parse `pycon` code blocks without indentation or fences.
## Installation
```bash
pip install markdown-pycon
```
## Configuration
This extension relies on the
[Highlight](https://facelessuser.github.io/pymdown-extensions/extensions/highlight/)
extension of
[PyMdown Extensions](https://facelessuser.github.io/pymdown-extensions/).
Configure from Python:
```python
from markdown import Markdown
Markdown(extensions=["pycon"])
```
...or in MkDocs configuration file, as a Markdown extension:
```yaml
# mkdocs.yml
markdown_extensions:
- pycon
```
## Usage
In your Markdown documents, simply write your `pycon` code blocks
without indentation or fences (triple backticks):
```md
>>> print("This is a pycon code block")
This is a pycon code block
```
This will get rendered as:
```pycon
>>> print("This is a pycon code block")
This is a pycon code block
```
[Doctest flags](https://docs.python.org/3/library/doctest.html#option-flags)
will be removed from the code lines.
Raw data
{
"_id": null,
"home_page": null,
"name": "markdown-pycon",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": null,
"author": null,
"author_email": "=?utf-8?q?Timoth=C3=A9e_Mazzucotelli?= <dev@pawamoy.fr>",
"download_url": "https://files.pythonhosted.org/packages/f4/44/bc5b35c24a475b46eb64ca0da6d482bda073cb0a4f189a05d637663c9bde/markdown_pycon-1.0.1.tar.gz",
"platform": null,
"description": "# Markdown PyCon\n\n[![ci](https://github.com/pawamoy/markdown-pycon/workflows/ci/badge.svg)](https://github.com/pawamoy/markdown-pycon/actions?query=workflow%3Aci)\n[![documentation](https://img.shields.io/badge/docs-mkdocs-708FCC.svg?style=flat)](https://pawamoy.github.io/markdown-pycon/)\n[![pypi version](https://img.shields.io/pypi/v/markdown-pycon.svg)](https://pypi.org/project/markdown-pycon/)\n[![gitter](https://badges.gitter.im/join%20chat.svg)](https://app.gitter.im/#/room/#markdown-pycon:gitter.im)\n\nMarkdown extension to parse `pycon` code blocks without indentation or fences.\n\n## Installation\n\n```bash\npip install markdown-pycon\n```\n\n## Configuration\n\nThis extension relies on the\n[Highlight](https://facelessuser.github.io/pymdown-extensions/extensions/highlight/)\nextension of\n[PyMdown Extensions](https://facelessuser.github.io/pymdown-extensions/).\n\nConfigure from Python:\n\n```python\nfrom markdown import Markdown\n\nMarkdown(extensions=[\"pycon\"])\n```\n\n...or in MkDocs configuration file, as a Markdown extension:\n\n```yaml\n# mkdocs.yml\nmarkdown_extensions:\n- pycon\n```\n\n## Usage\n\nIn your Markdown documents, simply write your `pycon` code blocks\nwithout indentation or fences (triple backticks):\n\n```md\n>>> print(\"This is a pycon code block\")\nThis is a pycon code block\n```\n\nThis will get rendered as:\n\n```pycon\n>>> print(\"This is a pycon code block\")\nThis is a pycon code block\n```\n\n[Doctest flags](https://docs.python.org/3/library/doctest.html#option-flags)\nwill be removed from the code lines.\n",
"bugtrack_url": null,
"license": "ISC",
"summary": "Markdown extension to parse `pycon` code blocks without indentation or fences.",
"version": "1.0.1",
"project_urls": {
"Changelog": "https://pawamoy.github.io/markdown-pycon/changelog",
"Discussions": "https://github.com/pawamoy/markdown-pycon/discussions",
"Documentation": "https://pawamoy.github.io/markdown-pycon",
"Funding": "https://github.com/sponsors/pawamoy",
"Gitter": "https://gitter.im/markdown-pycon/community",
"Homepage": "https://pawamoy.github.io/markdown-pycon",
"Issues": "https://github.com/pawamoy/markdown-pycon/issues",
"Repository": "https://github.com/pawamoy/markdown-pycon"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "80cb105897f8a5ad9b0d1b41b2175b350f8476c400f65ed232da80879516dadb",
"md5": "52605d47e8a3132b032717d8e262e2a8",
"sha256": "938ac2595c0056c10f497c2bde3e5add06797e485fc83b187b0eacc29a9ef7b2"
},
"downloads": -1,
"filename": "markdown_pycon-1.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "52605d47e8a3132b032717d8e262e2a8",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 6608,
"upload_time": "2025-01-10T01:05:20",
"upload_time_iso_8601": "2025-01-10T01:05:20.761185Z",
"url": "https://files.pythonhosted.org/packages/80/cb/105897f8a5ad9b0d1b41b2175b350f8476c400f65ed232da80879516dadb/markdown_pycon-1.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f444bc5b35c24a475b46eb64ca0da6d482bda073cb0a4f189a05d637663c9bde",
"md5": "890bc9ddf5bb6d3d9278b498b408943c",
"sha256": "02089b53b2056fd844e90e0c0ecd5c5b6f28d24daf313ddbea736fb90e066c32"
},
"downloads": -1,
"filename": "markdown_pycon-1.0.1.tar.gz",
"has_sig": false,
"md5_digest": "890bc9ddf5bb6d3d9278b498b408943c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 33394,
"upload_time": "2025-01-10T01:05:22",
"upload_time_iso_8601": "2025-01-10T01:05:22.144549Z",
"url": "https://files.pythonhosted.org/packages/f4/44/bc5b35c24a475b46eb64ca0da6d482bda073cb0a4f189a05d637663c9bde/markdown_pycon-1.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-10 01:05:22",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "pawamoy",
"github_project": "markdown-pycon",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "markdown-pycon"
}