{
"info": {
"author": "Eric Eastwood",
"author_email": "",
"bugtrack_url": null,
"classifiers": [
"Development Status :: 3 - Alpha",
"Environment :: Web Environment",
"Intended Audience :: Developers",
"License :: Other/Proprietary License",
"Operating System :: OS Independent",
"Programming Language :: Python :: 3"
],
"description": "[](https://github.com/ambv/black)\n\n# markdown-icons (`iconfonts.py`)\n\nEasily display icon fonts in python markdown. Just add the CSS necessary for your font and add this extension. \n\nThis is a 3rd party extension for [Python Markdown](https://pythonhosted.org/Markdown/). You can see a [full list of 3rd party extensions here](https://github.com/waylan/Python-Markdown/wiki/Third-Party-Extensions).\n\nAlthough this works with any icon font, users can use a `mod` syntax to add more prefixed classes to support [Font Awesome](http://fortawesome.github.io/Font-Awesome/) and its special classes such as `2x, 3x, muted, spin, etc`\n\nFurthermore, users can add their own `user_mod` syntax to add additional, non-prefixed, pre-defined classes for greater control over their icons while allowing you to control exactly what styles are allowed.\n\n- You can create your own Icon Fonts using the IcoMoon app: http://icomoon.io/app/\n- A great pre-made Icon Font is [Font Awesome (GitHub Project)](http://fortawesome.github.io/Font-Awesome/)\n\nSee the [python markdown documentation](http://pythonhosted.org/Markdown/) for more information.\n\nUse it in any personal or commercial project you want.\n\n# Syntax:\n\n- Accepts a-z, A-Z, 0-9, _(underscore), and - (hypen)\n- Uses [HTML Entity](http://www.w3schools.com/html/html_entities.asp) like syntax: `&entity_name;`\n\n```\n&icon-html5;\n&icon-css3;\n&icon-my-icon;\n```\n\nMod syntax:\n```\n&icon-html5:2x;\n&icon-quote:3x,muted;\n&icon-spinner:large,spin;\n```\n\nUser mod syntax:\n```\n&icon-html5::red;\n&icon-quote:2x:bold;\n```\n\n#### Example Markdown:\n\n```\nI love &icon-html5; and &icon-css3;\n&icon-spinner:large,spin; Sorry we have to load...\n```\n\n##### Output:\n\n```\nI love and \n Sorry we have to load...\n```\n\n# Installation:\n\n```bash\npip install markdown-iconfonts\n```\n\n# Usage / Setup:\n\n## Default Prefix is \"icon-\":\n\n```python\nimport markdown\n\nmd = markdown.Markdown(extensions=['iconfonts'])\n```\n\nor \n\n```Python\nimport markdown\nfrom iconfonts import IconFontsExtension\n\nmd = markdown.Markdown(extensions=[IconFontsExtension()])\n```\n\n#### The `base` option allows for use of Bootstrap 3 and FontAwesome 4 icons\n\n```python\nmd = markdown.Markdown(extensions=['iconfonts'],\n extension_configs={\"base\":\"icon\"})\nconverted_text = md.convert(text)\n```\n\n**Input:** `&icon-html5;`\n\n**Output:** ``\n\n#### `prefix_base_pairs` option\n\nThe `prefix_base_pairs` option allows for multiple prefix-base pairs to be specified, to allow you to support both Bootstrap 3/Glyphicon and FontAwesome icons\n\n``` \nmd = markdown.Markdown(extensions=['iconfonts'],\n extension_configs={\n 'iconfonts': {\n 'prefix_base_pairs': {\n 'fa-': 'fa',\n 'glyphicon-': 'glyphicon',\n }\n }\n })\nconverted_text = md.convert(text)\n```\n\n**Input:** `&glyphicon-remove; &fa-html5;`\n\n**Output:** ``\n\n# How to run the unit tests\n\n - Install `Markdown`: `pip install markdown`\n - Install markdown icons. Copy the `iconfonts.py` file into `site-packages/markdown/extensions/`\n - Navigate to the test directory in CMD/terminal and run `python unit-tests.py -v`\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/MadLittleMods/markdown-icons",
"keywords": "markdown,icons,fontawesome,bootstrap",
"license": "",
"maintainer": "",
"maintainer_email": "",
"name": "markdown-iconfonts",
"package_url": "https://pypi.org/project/markdown-iconfonts/",
"platform": "",
"project_url": "https://pypi.org/project/markdown-iconfonts/",
"project_urls": {
"Homepage": "https://github.com/MadLittleMods/markdown-icons"
},
"release_url": "https://pypi.org/project/markdown-iconfonts/3.0.0/",
"requires_dist": [
"markdown"
],
"requires_python": "",
"summary": "Easily display icon fonts in markdown.",
"version": "3.0.0"
},
"last_serial": 4602902,
"releases": {
"2.1.1": [
{
"comment_text": "",
"digests": {
"md5": "72c24b292f5ecb0a873e25ec856d3922",
"sha256": "d6f75dc46b3b0e4e40c2423cfb392df9e299710adbd002e3666ac845a92a914a"
},
"downloads": -1,
"filename": "markdown_iconfonts-2.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "72c24b292f5ecb0a873e25ec856d3922",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 4568,
"upload_time": "2018-12-07T14:55:59",
"url": "https://files.pythonhosted.org/packages/e6/33/05580cccf374fec3dba59ebdc7bdf72a0d3f59edd17554e1bbd0c0d0b755/markdown_iconfonts-2.1.1-py3-none-any.whl"
},
{
"comment_text": "",
"digests": {
"md5": "a9b553f90869cb9b9e7e87891c6d354a",
"sha256": "3eaadfacc48dc5e7bb35626681c828699c81bbbf880abf1f7adcab2761acd775"
},
"downloads": -1,
"filename": "markdown-iconfonts-2.1.1.tar.gz",
"has_sig": false,
"md5_digest": "a9b553f90869cb9b9e7e87891c6d354a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 5739,
"upload_time": "2018-12-07T14:56:01",
"url": "https://files.pythonhosted.org/packages/a7/89/b8285de738c4a02b6ed6c9a12e72ea34acf1bc97671bf5652f4e8d2a9575/markdown-iconfonts-2.1.1.tar.gz"
}
],
"3.0.0": [
{
"comment_text": "",
"digests": {
"md5": "07e2b96aae75f5eda334c7dbc3ff5414",
"sha256": "0c6faa00242893b115e2fbbc9d08949651ae7474d0cf0d3305f26b196ee1fa74"
},
"downloads": -1,
"filename": "markdown_iconfonts-3.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "07e2b96aae75f5eda334c7dbc3ff5414",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 4775,
"upload_time": "2018-12-15T15:17:32",
"url": "https://files.pythonhosted.org/packages/5a/f8/5a04c6dc0743769cea3cde4fe4cb62ca320c07524986b254bdc890ce4f80/markdown_iconfonts-3.0.0-py3-none-any.whl"
},
{
"comment_text": "",
"digests": {
"md5": "7b8e59e248dc4dcca524e2cd0b7508a9",
"sha256": "5cdc0d4e80cb4cbc2301e4b3430488bf2e07b95a2664a5ebe1451b6c175a1839"
},
"downloads": -1,
"filename": "markdown-iconfonts-3.0.0.tar.gz",
"has_sig": false,
"md5_digest": "7b8e59e248dc4dcca524e2cd0b7508a9",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 5392,
"upload_time": "2018-12-15T15:17:34",
"url": "https://files.pythonhosted.org/packages/c7/90/7955c77aea8e1b32ca7fff1d3f8393991ee720135d427a42940ed6ec872a/markdown-iconfonts-3.0.0.tar.gz"
}
]
},
"urls": [
{
"comment_text": "",
"digests": {
"md5": "07e2b96aae75f5eda334c7dbc3ff5414",
"sha256": "0c6faa00242893b115e2fbbc9d08949651ae7474d0cf0d3305f26b196ee1fa74"
},
"downloads": -1,
"filename": "markdown_iconfonts-3.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "07e2b96aae75f5eda334c7dbc3ff5414",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 4775,
"upload_time": "2018-12-15T15:17:32",
"url": "https://files.pythonhosted.org/packages/5a/f8/5a04c6dc0743769cea3cde4fe4cb62ca320c07524986b254bdc890ce4f80/markdown_iconfonts-3.0.0-py3-none-any.whl"
},
{
"comment_text": "",
"digests": {
"md5": "7b8e59e248dc4dcca524e2cd0b7508a9",
"sha256": "5cdc0d4e80cb4cbc2301e4b3430488bf2e07b95a2664a5ebe1451b6c175a1839"
},
"downloads": -1,
"filename": "markdown-iconfonts-3.0.0.tar.gz",
"has_sig": false,
"md5_digest": "7b8e59e248dc4dcca524e2cd0b7508a9",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 5392,
"upload_time": "2018-12-15T15:17:34",
"url": "https://files.pythonhosted.org/packages/c7/90/7955c77aea8e1b32ca7fff1d3f8393991ee720135d427a42940ed6ec872a/markdown-iconfonts-3.0.0.tar.gz"
}
]
}