# ksconf-jinja-markdown
Add Markdown rendering support to the Ksconf packing ecosystem.
This allows rendering markdown into html when using Jinja (`*.j2`) files within
a rendered Splunk app using the `ksconf package` command.
## Jinja filter
* `markdown2html` - Filter used to convert markdown text into HTML output.
## Install
```sh
pip install -U ksconf-jinja2-markdown
```
Installation can be validated by running: `ksconf --version`
## Example Usage
Simple XML with an input
Contents of `my_app/default/data/view/my_dashboard.xml.j2`:
```xml
<dashboard>
<row>
<html>
{{ description | markdown2html }}
</html>
</row>
</dashboard>
```
Contents of `inputs.json`:
```json
{
"description": "# Title\n## Header 2\n* bulleted\n* list\n"
}
```
```sh
ksconf package --enable-handler=jinja --template_vars @inputs.conf my_app
```
## Release steps
```sh
python setup.py bdist_wheel sdist
twine upload dist/ksconf_jinja_markdown-*any.whl dist/ksconf-jinja-markdown-*.tar.gz
```
Raw data
{
"_id": null,
"home_page": "https://github.com/Kintyre/ksconf/tree/devel/plugins/jinja-markdown",
"name": "ksconf-jinja-markdown",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "ksconf splunk jinja markdown",
"author": "Lowell Alleman",
"author_email": "lowell.alleman@cdillc.com",
"download_url": "https://files.pythonhosted.org/packages/95/0c/6ce81d1ed8191dee94809be64d73c02af869b8a90af2bbf79c9f7f159666/ksconf-jinja-markdown-1.1.0.tar.gz",
"platform": null,
"description": "# ksconf-jinja-markdown\n\nAdd Markdown rendering support to the Ksconf packing ecosystem.\nThis allows rendering markdown into html when using Jinja (`*.j2`) files within\na rendered Splunk app using the `ksconf package` command.\n\n## Jinja filter\n\n* `markdown2html` - Filter used to convert markdown text into HTML output.\n\n## Install\n\n```sh\npip install -U ksconf-jinja2-markdown\n```\n\nInstallation can be validated by running: `ksconf --version`\n\n\n## Example Usage\n\nSimple XML with an input\n\nContents of `my_app/default/data/view/my_dashboard.xml.j2`:\n\n```xml\n<dashboard>\n <row>\n <html>\n {{ description | markdown2html }}\n </html>\n </row>\n</dashboard>\n```\n\nContents of `inputs.json`:\n\n```json\n{\n \"description\": \"# Title\\n## Header 2\\n* bulleted\\n* list\\n\"\n}\n```\n\n```sh\nksconf package --enable-handler=jinja --template_vars @inputs.conf my_app\n```\n\n\n## Release steps\n\n```sh\npython setup.py bdist_wheel sdist\ntwine upload dist/ksconf_jinja_markdown-*any.whl dist/ksconf-jinja-markdown-*.tar.gz\n```\n\n",
"bugtrack_url": null,
"license": "",
"summary": "Markdown rendering support for Jinja2 templates within Ksconf",
"version": "1.1.0",
"project_urls": {
"Homepage": "https://github.com/Kintyre/ksconf/tree/devel/plugins/jinja-markdown"
},
"split_keywords": [
"ksconf",
"splunk",
"jinja",
"markdown"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "47f0c7cf93b4e227b84b80afe14cd5a99d60369e9aa9aa73edd70fd1ce1281e9",
"md5": "cb8b88cce6ac81c3451dc89479b45605",
"sha256": "68e96fe6261228cda0027d100ca519ee935a15db021b65761c5887ff8c62ee78"
},
"downloads": -1,
"filename": "ksconf_jinja_markdown-1.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "cb8b88cce6ac81c3451dc89479b45605",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 2210,
"upload_time": "2023-10-05T20:12:21",
"upload_time_iso_8601": "2023-10-05T20:12:21.450070Z",
"url": "https://files.pythonhosted.org/packages/47/f0/c7cf93b4e227b84b80afe14cd5a99d60369e9aa9aa73edd70fd1ce1281e9/ksconf_jinja_markdown-1.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "950c6ce81d1ed8191dee94809be64d73c02af869b8a90af2bbf79c9f7f159666",
"md5": "4dc4439665b8d062d520fdb1558008d3",
"sha256": "970904ed6a704f7e1a6353122198522971be8d47eaa026af786397f56e3c1dd0"
},
"downloads": -1,
"filename": "ksconf-jinja-markdown-1.1.0.tar.gz",
"has_sig": false,
"md5_digest": "4dc4439665b8d062d520fdb1558008d3",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 2110,
"upload_time": "2023-10-05T20:12:22",
"upload_time_iso_8601": "2023-10-05T20:12:22.988561Z",
"url": "https://files.pythonhosted.org/packages/95/0c/6ce81d1ed8191dee94809be64d73c02af869b8a90af2bbf79c9f7f159666/ksconf-jinja-markdown-1.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-10-05 20:12:22",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Kintyre",
"github_project": "ksconf",
"travis_ci": true,
"coveralls": true,
"github_actions": true,
"appveyor": true,
"requirements": [],
"tox": true,
"lcname": "ksconf-jinja-markdown"
}
JSON
