| Name | markdown-callouts JSON |
| Version |
0.4.0
JSON |
| download |
| home_page | |
| Summary | Markdown extension: a classier syntax for admonitions |
| upload_time | 2024-01-22 23:18:18 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.8 |
| license | |
| keywords |
extensions
markdown
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# markdown-callouts
**Extension for [Python-Markdown][]: a classier syntax for [admonitions](https://squidfunk.github.io/mkdocs-material/reference/admonitions/#usage)**
[](https://pypi.org/project/markdown-callouts/)
[](https://github.com/oprypin/markdown-callouts/blob/master/LICENSE.md)
[](https://github.com/oprypin/markdown-callouts/actions?query=event%3Apush+branch%3Amaster)
[python-markdown]: https://python-markdown.github.io/
[admonition]: https://python-markdown.github.io/extensions/admonition/
[mkdocs]: https://www.mkdocs.org/
[documentation site]: https://oprypin.github.io/markdown-callouts/
## Installation
```shell
pip install markdown-callouts
```
If using MkDocs, [enable the extension in **mkdocs.yml**](https://www.mkdocs.org/user-guide/configuration/#markdown_extensions):
```yaml
markdown_extensions:
- callouts
```
**Continue to the [documentation site][].**
## Usage
This adds a new block-level syntax to Markdown, to put a paragraph of text into a block that's specially highlighted and set apart from the rest of the text.
**Example:**
```markdown
NOTE: Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod
nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor
massa, nec semper lorem quam in massa.
```
**Result**, [using *mkdocs-material*](https://squidfunk.github.io/mkdocs-material/reference/admonitions/#usage):
Collapsible blocks also have a syntax for them:
```markdown
>? NOTE: Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod
> nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor
> massa, nec semper lorem quam in massa.
```
This instead shows up as an initially-closed `<details>` block.
### Graceful degradation
This extension produces the same results as the *[admonition][]* extension, but with a syntax that is much less intrusive and has a very reasonable fallback look for "vanilla" renderers.
E.g. compare what you would've seen above if we actually wrote that Markdown and fed it to GitHub's Markdown parser:
<table markdown="1">
<tr><th>"Callouts" syntax</th></tr>
<tr><td>
NOTE: Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod
nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor
massa, nec semper lorem quam in massa.
</td></tr>
<tr><th>"Admonition" syntax</th></tr>
<tr><td>
!!! note
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod
nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor
massa, nec semper lorem quam in massa.
</td></tr>
</table>
---
**Continue to the [documentation site][].**
Raw data
{
"_id": null,
"home_page": "",
"name": "markdown-callouts",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "extensions,markdown",
"author": "",
"author_email": "Oleh Prypin <oleh@pryp.in>",
"download_url": "https://files.pythonhosted.org/packages/87/73/ae5aa379f6f7fea9d0bf4cba888f9a31d451d90f80033ae60ae3045770d5/markdown_callouts-0.4.0.tar.gz",
"platform": null,
"description": "# markdown-callouts\n\n**Extension for [Python-Markdown][]: a classier syntax for [admonitions](https://squidfunk.github.io/mkdocs-material/reference/admonitions/#usage)**\n\n[](https://pypi.org/project/markdown-callouts/)\n[](https://github.com/oprypin/markdown-callouts/blob/master/LICENSE.md)\n[](https://github.com/oprypin/markdown-callouts/actions?query=event%3Apush+branch%3Amaster)\n\n[python-markdown]: https://python-markdown.github.io/\n[admonition]: https://python-markdown.github.io/extensions/admonition/\n[mkdocs]: https://www.mkdocs.org/\n[documentation site]: https://oprypin.github.io/markdown-callouts/\n\n## Installation\n\n```shell\npip install markdown-callouts\n```\n\nIf using MkDocs, [enable the extension in **mkdocs.yml**](https://www.mkdocs.org/user-guide/configuration/#markdown_extensions):\n\n```yaml\nmarkdown_extensions:\n - callouts\n```\n\n**Continue to the [documentation site][].**\n\n## Usage\n\nThis adds a new block-level syntax to Markdown, to put a paragraph of text into a block that's specially highlighted and set apart from the rest of the text.\n\n**Example:**\n\n```markdown\nNOTE: Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod\nnulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor\nmassa, nec semper lorem quam in massa.\n```\n\n**Result**, [using *mkdocs-material*](https://squidfunk.github.io/mkdocs-material/reference/admonitions/#usage):\n\n\n\nCollapsible blocks also have a syntax for them:\n\n```markdown\n>? NOTE: Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod\n> nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor\n> massa, nec semper lorem quam in massa.\n```\n\nThis instead shows up as an initially-closed `<details>` block.\n\n### Graceful degradation\n\nThis extension produces the same results as the *[admonition][]* extension, but with a syntax that is much less intrusive and has a very reasonable fallback look for \"vanilla\" renderers.\n\nE.g. compare what you would've seen above if we actually wrote that Markdown and fed it to GitHub's Markdown parser:\n\n<table markdown=\"1\">\n<tr><th>\"Callouts\" syntax</th></tr>\n<tr><td>\n\nNOTE: Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod\nnulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor\nmassa, nec semper lorem quam in massa.\n\n</td></tr>\n<tr><th>\"Admonition\" syntax</th></tr>\n<tr><td>\n\n!!! note\n\n Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod\n nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor\n massa, nec semper lorem quam in massa.\n\n</td></tr>\n</table>\n\n---\n\n**Continue to the [documentation site][].**\n",
"bugtrack_url": null,
"license": "",
"summary": "Markdown extension: a classier syntax for admonitions",
"version": "0.4.0",
"project_urls": {
"Documentation": "https://oprypin.github.io/markdown-callouts/",
"History": "https://github.com/oprypin/markdown-callouts/releases",
"Issues": "https://github.com/oprypin/markdown-callouts/issues",
"Source": "https://github.com/oprypin/markdown-callouts"
},
"split_keywords": [
"extensions",
"markdown"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "1db57b0a0a52c82bfccd830af2a8cc8add1c5bc932e0204922434954a631dd51",
"md5": "263813ce3d0d419ee37ea51d5f2e6815",
"sha256": "ed0da38f29158d93116a0d0c6ecaf9df90b37e0d989b5337d678ee6e6d6550b7"
},
"downloads": -1,
"filename": "markdown_callouts-0.4.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "263813ce3d0d419ee37ea51d5f2e6815",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 7108,
"upload_time": "2024-01-22T23:18:17",
"upload_time_iso_8601": "2024-01-22T23:18:17.465158Z",
"url": "https://files.pythonhosted.org/packages/1d/b5/7b0a0a52c82bfccd830af2a8cc8add1c5bc932e0204922434954a631dd51/markdown_callouts-0.4.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "8773ae5aa379f6f7fea9d0bf4cba888f9a31d451d90f80033ae60ae3045770d5",
"md5": "20f92ca493c8a7bf495a304a21691290",
"sha256": "7ed2c90486967058a73a547781121983839522d67041ae52c4979616f1b2b746"
},
"downloads": -1,
"filename": "markdown_callouts-0.4.0.tar.gz",
"has_sig": false,
"md5_digest": "20f92ca493c8a7bf495a304a21691290",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 9768,
"upload_time": "2024-01-22T23:18:18",
"upload_time_iso_8601": "2024-01-22T23:18:18.513663Z",
"url": "https://files.pythonhosted.org/packages/87/73/ae5aa379f6f7fea9d0bf4cba888f9a31d451d90f80033ae60ae3045770d5/markdown_callouts-0.4.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-22 23:18:18",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "oprypin",
"github_project": "markdown-callouts",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "markdown-callouts"
}
