Skip to content

Commit 2290b66

Browse files
committed
Add note to docs about the importance of only one custom-icons.js
1 parent f68e307 commit 2290b66

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

docs/user_guide/header-links.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -245,6 +245,14 @@ to set up the ``.svg`` to be used as a FontAwesome type icon. This is a fairly s
245245

246246
``defer`` attribute is required.
247247

248+
.. important::
249+
250+
Do not add more than one ``custom-icons.js`` file in your ``conf.py``.
251+
252+
Each custom icon js file includes a call to ``FontAwesome.library.add()``.
253+
Your site's JavaScript can only call that function once. In our testing,
254+
subsequent calls to that function do not load additional icons.
255+
248256
#. Set up the icon link in the ``html_theme_options`` as a FontAwesome icon:
249257

250258
.. code:: python

0 commit comments

Comments
 (0)