https://github.com/madlittlemods/markdown-icons
Easily display icon fonts in markdown.
https://github.com/madlittlemods/markdown-icons
Last synced: about 2 months ago
JSON representation
Easily display icon fonts in markdown.
- Host: GitHub
- URL: https://github.com/madlittlemods/markdown-icons
- Owner: MadLittleMods
- License: other
- Created: 2013-10-10T01:13:21.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2018-12-15T15:07:39.000Z (over 6 years ago)
- Last Synced: 2024-04-14T06:01:40.247Z (about 1 year ago)
- Language: Python
- Size: 26.4 KB
- Stars: 11
- Watchers: 5
- Forks: 11
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# markdown-icons (`iconfonts.py`)
Easily display icon fonts in python markdown. Just add the CSS necessary for your font and add this extension.
This 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).
Although 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`
Furthermore, 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.
- You can create your own Icon Fonts using the IcoMoon app: http://icomoon.io/app/
- A great pre-made Icon Font is [Font Awesome (GitHub Project)](http://fortawesome.github.io/Font-Awesome/)
See the [python markdown documentation](http://pythonhosted.org/Markdown/) for more information.
Use it in any personal or commercial project you want.
# Current Version: 2.1
# Syntax:
- Accepts a-z, A-Z, 0-9, _(underscore), and - (hypen)
- Uses [HTML Entity](http://www.w3schools.com/html/html_entities.asp) like syntax: `&entity_name;`
```
&icon-html5;
&icon-css3;
&icon-my-icon;
```
Mod syntax:
```
&icon-html5:2x;
&icon-quote:3x,muted;
&icon-spinner:large,spin;
```
User mod syntax:
```
&icon-html5::red;
&icon-quote:2x:bold;
```
#### Example Markdown:
```
I love &icon-html5; and &icon-css3;
&icon-spinner:large,spin; Sorry we have to load...
```
##### Output:
```
I love and
Sorry we have to load...
```
# Installation:
Just drop it in the extensions folder of the markdown package: `markdown/extensions`
# Usage / Setup:
#### Default Prefix is "icon-":
##### In a Django Template:
`{{ textmd|markdown:"safe,iconfonts" }}`
##### In Python:
```
md = markdown.Markdown(extensions=['iconfonts'])
converted_text = md.convert(text)
```
#### Use a custom Prefix:
##### In a Django Template:
`{{ textmd|markdown:"safe,iconfonts(prefix=mypref-)" }}`
##### In Python:
```
md = markdown.Markdown(extensions=['iconfonts(prefix=mypref-)'])
converted_text = md.convert(text)
```
#### No prefix (just in case you couldn't figure it out :P):
This isn't suggested, as it will take over the already built in HTML Entities
##### In Python:
```
md = markdown.Markdown(extensions=['iconfonts(prefix=)'])
converted_text = md.convert(text)
```
#### The `base` option allows for use of Bootstrap 3 and FontAwesome 4 icons
##### In Python:
```
md = markdown.Markdown(extensions=['iconfonts(base=icon)'])
converted_text = md.convert(text)
```
**Input:** `&icon-html5;`
**Output:** ``
#### Combine options with a comma:
```
md = markdown.Markdown(extensions=['iconfonts(prefix=fa-, base=fa)'])
```
#### `prefix_base_pairs` option
The `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
##### In Python:
```
md = markdown.Markdown(extensions=['iconfonts'],
extension_configs={
'iconfonts': {
'prefix_base_pairs': {
'fa-': 'fa',
'glyphicon-': 'glyphicon',
}
}
})
converted_text = md.convert(text)
```
**Input:** `&glyphicon-remove; &fa-html5;`
**Output:** ``
# How to run the unit tests
- Install `Markdown`: `pip install markdown`
- Install markdown icons. Copy the `iconfonts.py` file into `site-packages/markdown/extensions/`
- Navigate to the test directory in CMD/terminal and run `python unit-tests.py -v`