|
||
---|---|---|
sphinx_fasvg | ||
.gitignore | ||
CHANGES | ||
LICENSE | ||
LICENSE-de | ||
LICENSE-fr | ||
LICENSE-nl | ||
README.rst | ||
pyproject.toml |
README.rst
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
</head>
Fontawesome SVG for Sphinx
Install the module :
python setup.py install
Download SVGs from fontawesome website. Configure it in your conf.py:
fa_brands_path = '_static/fa/brands.svg'
fa_regular_path = '_static/fa/regular.svg'
fa_solid_path = '_static/fa/solid.svg'
Use inline references for brands, regular or solid:
Display an icon, with no alt text and aria-hidden:
:fab:`icon`
:far:`icon`
:fas:`icon`
:fab:`icon[alt text]`
:far:`icon[alt text]`
:fas:`icon[alt text]`
An icon with some attributes:
.. far:: icon
:class: myclass
:id: myid
:alt: alt text
For links with fasvglink and icon name as classes.
This can be used to create fancy social links
:fablink:`icon: Text <url>`
:farlink:`icon: Text <url>`
:faslink:`icon: Text <url>`
:fablink:`icon: Text[alt text] <url>`
:farlink:`icon: Text[alt text] <url>`
:faslink:`icon: Text[alt text] <url>`
By kujiu, EUPL 1.2 licence.
</html>