{ "info": { "author": "Daniil Minukhin", "author_email": "ddddsa@gmail.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 5 - Production/Stable", "Environment :: Console", "Intended Audience :: Developers", "License :: OSI Approved :: MIT License", "Operating System :: OS Independent", "Programming Language :: Python", "Topic :: Documentation", "Topic :: Utilities" ], "description": "https://img.shields.io/pypi/v/foliantcontrib.admonitions.svg\n\n# Admonitions preprocessor for Foliant\n\nPreprocessor which tries to make admonitions syntax available for most backends.\n\nAdmonitions are decorated fragments of text which indicate a warning, notice, tip, etc.\n\nWe use [rST-style syntax for admonitions](https://python-markdown.github.io/extensions/admonition/) which is already supported by mkdocs backend with `admonition` extension turned on. This preprocessor makes this syntax work for pandoc and slate backends.\n\n## Installation\n\n```bash\n$ pip install foliantcontrib.admonitions\n```\n\n## Config\n\nJust add `admonitions` into your preprocessors list. Right now the preprocessor doesn't have any options:\n\n```yaml\npreprocessors:\n - admonitions\n```\n\n## Usage\n\nAdd an admonition to your Markdown file:\n\n```\n!!! warning \"optional admonition title\"\n Admonition text.\n\n May be several paragraphs.\n```\n\n### Notes for slate\n\nSlate has its own admonitions syntax of three types: `notice` (blue notes), `warning` (red warnings) and `success` (green notes). If another type is supplied, slate draws a blue note but without the \"i\" icon.\n\nAdmonitions preprocessor transforms some of the general admonition types into slate's for convenience (so you could use `error` type to display same kind of note in both slate and mkdocs). These translations are indicated in the table below:\n\noriginal type | translates to\n------------- | -------------\nerror | warning\ndanger | warning\ncaution | warning\ninfo | notice\nnote | notice\ntip | notice\nhint | notice\n\n\n\n", "description_content_type": "text/markdown", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/foliant-docs/foliantcontrib.admonitions", "keywords": "", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "foliantcontrib.admonitions", "package_url": "https://pypi.org/project/foliantcontrib.admonitions/", "platform": "any", "project_url": "https://pypi.org/project/foliantcontrib.admonitions/", "project_urls": { "Homepage": "https://github.com/foliant-docs/foliantcontrib.admonitions" }, "release_url": "https://pypi.org/project/foliantcontrib.admonitions/1.0.0/", "requires_dist": [ "foliant (>=1.0.8)", "foliantcontrib.utils.preprocessor-ext (>=1.0.0)" ], "requires_python": "", "summary": "Preprocessor for admonitions", "version": "1.0.0" }, "last_serial": 5790256, "releases": { "1.0.0": [ { "comment_text": "", "digests": { "md5": "341622f6bfe0ada6b9545c57f0f28bbf", "sha256": "ad93555f64f84864cdeb87464477d65815c0afdc66a2211a2539d780304f5bbd" }, "downloads": -1, "filename": "foliantcontrib.admonitions-1.0.0-py3-none-any.whl", "has_sig": false, "md5_digest": "341622f6bfe0ada6b9545c57f0f28bbf", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 4102, "upload_time": "2019-06-10T10:29:23", "url": "https://files.pythonhosted.org/packages/b7/45/9e43deccf085dd5200817fa55d469dd927ddeb4215d9e29c90bec96077e8/foliantcontrib.admonitions-1.0.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "8af406577d69fcc8f42e96b375fc4792", "sha256": "4ff9d4341e73cdf7847333fe95adf0c55594fc17612a32fd7da705e71e5ff4b5" }, "downloads": -1, "filename": "foliantcontrib.admonitions-1.0.0.tar.gz", "has_sig": false, "md5_digest": "8af406577d69fcc8f42e96b375fc4792", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 3059, "upload_time": "2019-06-10T10:29:25", "url": "https://files.pythonhosted.org/packages/b2/31/2bfdff57b74a061f26f99aa894287fa6961e99dbdec2d51c9229c1272bc6/foliantcontrib.admonitions-1.0.0.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "341622f6bfe0ada6b9545c57f0f28bbf", "sha256": "ad93555f64f84864cdeb87464477d65815c0afdc66a2211a2539d780304f5bbd" }, "downloads": -1, "filename": "foliantcontrib.admonitions-1.0.0-py3-none-any.whl", "has_sig": false, "md5_digest": "341622f6bfe0ada6b9545c57f0f28bbf", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 4102, "upload_time": "2019-06-10T10:29:23", "url": "https://files.pythonhosted.org/packages/b7/45/9e43deccf085dd5200817fa55d469dd927ddeb4215d9e29c90bec96077e8/foliantcontrib.admonitions-1.0.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "8af406577d69fcc8f42e96b375fc4792", "sha256": "4ff9d4341e73cdf7847333fe95adf0c55594fc17612a32fd7da705e71e5ff4b5" }, "downloads": -1, "filename": "foliantcontrib.admonitions-1.0.0.tar.gz", "has_sig": false, "md5_digest": "8af406577d69fcc8f42e96b375fc4792", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 3059, "upload_time": "2019-06-10T10:29:25", "url": "https://files.pythonhosted.org/packages/b2/31/2bfdff57b74a061f26f99aa894287fa6961e99dbdec2d51c9229c1272bc6/foliantcontrib.admonitions-1.0.0.tar.gz" } ] }