<div align="center">
StepsList
=========================================
[](https://pypi.org/project/stepslist/)
[](https://github.com/A3Bagged/stepslist-extension/blob/main/LICENSE.md)
**Extension for [Python-Markdown](https://python-markdown.github.io/): to be used on [Mkdocs](https://github.com/mkdocs/mkdocs) and [Material for Mkdocs](https://github.com/squidfunk/mkdocs-material)**
This Python package provides a custom Markdown extension that allows users to define step blocks in their Markdown documents. The extension recognizes specific markers and formats the enclosed content for better readability.
</div>
## Features
- Define step blocks using `--steps--` and `--!steps--` markers.
- Automatically wraps the content in a `<div>` with a class for custom styling.
- Easy integration with the existing Markdown parser.
## Installation
To use this extension, ensure you have the markdown library installed. You can install it using pip:
```bash
pip install markdown
```
You can install this package using pip:
```bash
pip install stepslist
```
## Usage
To use this extension, add it to your MkDocs configuration file (`mkdocs.yml`):
```
markdown_extensions:
- stepslist
```
Now, you can use the `--steps--` `--!steps--` tag in your Markdown files:
> [!IMPORTANT]
> Note that you will need blank lines between the tags and your list otherwise it will not work!
### Markdown
```
--steps--
1. Step one
2. Step two
3. Step three
--!steps--
```
### Output example
This will be rendered as an ordered list within a div that you can style:
```
<div class="md-steps">
<ol>
<li>Step one</li>
<li>Step two</li>
<li>Step three</li>
</ol>
</div>
```
### Styling
To style in `CSS` you need the following selectors:
You can also style the `::before` and `::after` pseudo elements.
It's recommended to keep the `.md-steps` styling for the div itself unchanged unless you need to
```
.md-steps ol {
/* Styling goes here */
}
.md-steps>ol>li {
/* Styling goes here */
}
/* Optional */
.md-steps>ol>li::before {
/* Styling goes here */
}
.md-steps>ol>li::after {
/* Styling goes here */
}
```
<div align="center">
_If you like this extension consider buying me a :coffee:[coffee](https://ko-fi.com/cvanliere)._
</div>
Raw data
{
"_id": null,
"home_page": "https://github.com/a3bagged/stepslist-extension",
"name": "stepslist",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": null,
"author": "Chris van Liere",
"author_email": "c.vnliere@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/ca/8a/1b1b56599af0ca876a1a165eba346414667062b3088a43eb239051e3523e/stepslist-0.7.5.tar.gz",
"platform": null,
"description": "<div align=\"center\">\r\n\r\nStepsList\r\n=========================================\r\n\r\n[](https://pypi.org/project/stepslist/)\r\n\r\n[](https://github.com/A3Bagged/stepslist-extension/blob/main/LICENSE.md)\r\n\r\n\r\n**Extension for [Python-Markdown](https://python-markdown.github.io/): to be used on [Mkdocs](https://github.com/mkdocs/mkdocs) and [Material for Mkdocs](https://github.com/squidfunk/mkdocs-material)**\r\n\r\n\r\nThis Python package provides a custom Markdown extension that allows users to define step blocks in their Markdown documents. The extension recognizes specific markers and formats the enclosed content for better readability.\r\n\r\n</div>\r\n\r\n## Features\r\n- Define step blocks using `--steps--` and `--!steps--` markers.\r\n- Automatically wraps the content in a `<div>` with a class for custom styling.\r\n- Easy integration with the existing Markdown parser.\r\n\r\n## Installation\r\nTo use this extension, ensure you have the markdown library installed. You can install it using pip:\r\n```bash\r\npip install markdown\r\n```\r\n\r\nYou can install this package using pip:\r\n\r\n```bash\r\npip install stepslist\r\n```\r\n\r\n## Usage\r\nTo use this extension, add it to your MkDocs configuration file (`mkdocs.yml`):\r\n\r\n```\r\nmarkdown_extensions:\r\n - stepslist\r\n```\r\nNow, you can use the `--steps--` `--!steps--` tag in your Markdown files:\r\n\r\n> [!IMPORTANT]\r\n> Note that you will need blank lines between the tags and your list otherwise it will not work!\r\n\r\n### Markdown\r\n\r\n```\r\n--steps--\r\n\r\n1. Step one\r\n2. Step two\r\n3. Step three\r\n\r\n--!steps--\r\n```\r\n### Output example\r\nThis will be rendered as an ordered list within a div that you can style:\r\n\r\n```\r\n<div class=\"md-steps\">\r\n <ol>\r\n <li>Step one</li>\r\n <li>Step two</li>\r\n <li>Step three</li>\r\n </ol>\r\n</div>\r\n```\r\n\r\n### Styling\r\nTo style in `CSS` you need the following selectors:\r\nYou can also style the `::before` and `::after` pseudo elements. \r\nIt's recommended to keep the `.md-steps` styling for the div itself unchanged unless you need to\r\n```\r\n.md-steps ol {\r\n /* Styling goes here */\r\n}\r\n\r\n.md-steps>ol>li {\r\n /* Styling goes here */\r\n}\r\n\r\n/* Optional */\r\n.md-steps>ol>li::before {\r\n /* Styling goes here */\r\n}\r\n\r\n.md-steps>ol>li::after {\r\n /* Styling goes here */\r\n}\r\n```\r\n\r\n<div align=\"center\">\r\n\r\n_If you like this extension consider buying me a :coffee:[coffee](https://ko-fi.com/cvanliere)._\r\n\r\n</div>\r\n",
"bugtrack_url": null,
"license": null,
"summary": "A MkDocs extension to improve the visual of ordered lists.",
"version": "0.7.5",
"project_urls": {
"Homepage": "https://github.com/a3bagged/stepslist-extension"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "6f0dcbc21c48d27816b75e1fb64c9407b9638fc7179d3f649f0ab965298e5396",
"md5": "7f015d1daab105daa5a53ffadd7318ed",
"sha256": "d432b8aabb1338aba5480c12e4e665d79c81d0edafb7adcffe80035c3f0dd649"
},
"downloads": -1,
"filename": "stepslist-0.7.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "7f015d1daab105daa5a53ffadd7318ed",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 4465,
"upload_time": "2024-12-09T04:17:21",
"upload_time_iso_8601": "2024-12-09T04:17:21.582039Z",
"url": "https://files.pythonhosted.org/packages/6f/0d/cbc21c48d27816b75e1fb64c9407b9638fc7179d3f649f0ab965298e5396/stepslist-0.7.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ca8a1b1b56599af0ca876a1a165eba346414667062b3088a43eb239051e3523e",
"md5": "dfb7d755980fc6e04366e9350c61a3fd",
"sha256": "8d08f815231895bbb239aee7ea34a4e1e8d589f8322ffc3697081cc70de93eee"
},
"downloads": -1,
"filename": "stepslist-0.7.5.tar.gz",
"has_sig": false,
"md5_digest": "dfb7d755980fc6e04366e9350c61a3fd",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 3929,
"upload_time": "2024-12-09T04:17:23",
"upload_time_iso_8601": "2024-12-09T04:17:23.306263Z",
"url": "https://files.pythonhosted.org/packages/ca/8a/1b1b56599af0ca876a1a165eba346414667062b3088a43eb239051e3523e/stepslist-0.7.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-09 04:17:23",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "a3bagged",
"github_project": "stepslist-extension",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "stepslist"
}
JSON
