gaschz/trilium
1
0
Fork 0
mirror of https://github.com/zadam/trilium.git synced 2025-12-31 11:44:23 +01:00
Code Issues Actions 13 Packages Projects Releases Wiki Activity
trilium/docs/User Guide/User Guide/Basic Concepts and Features/Themes/Icon Packs.md
Elian Doran d834cd78a7
docs(user): document icon packs
2025-12-28 11:43:25 +02:00

3.7 KiB
Vendored
Raw Blame History

Icon Packs

Importing an existing icon pack

Icon packs are specific to Trilium, so they must either be created from scratch (see below) or imported from a ZIP file from a third-party developer.

Note

Icon packs are third-party content

The Trilium maintainers are not responsible for keeping these icon packs up to date. If you have an issue with a specific icon pack, then the issue must be reported to the third-party developer responsible for it, not the Trilium team.

To import an icon pack:

  1. Ideally, create a dedicated spot in your note tree where to place the icon packs.
  2. Right click the note where to put it and select Import into note.
  3. Uncheck Safe import.
  4. Select Import.
  5. Refresh the application.

Warning

Since Safe import is disabled, make sure you trust the source as it could contain dangerous third-party scripts. One good way to check if the icon pack is safe is to manually extract the .zip and inspect the file contents. Icon packs should only contain a font file and a JSON file. Other files (especially scripts) are to be considered harmful.

Creating an icon pack

Creating an icon pack requires some scripting knowledge outside Trilium in order to generate the list of icons. For information, see Creating an icon pack.

Using an icon from an icon pack

After refreshing the application, the icon pack should be enabled by default. To test this, simply select an existing note or create a new one and try to change the note icon.

There should be a Filter button to the right of the search bar in the icon list. Clicking it allows filtering by icon pack and the newly imported icon pack should be displayed there.

Note

If the icon pack is missing from that list, then most likely there's something wrong with it.

  • Try checking the Backend (server) logs for clues and make sure that the icon pack has the #iconPack label with a value assigned to it (a prefix).
  • Icon packs that are protected are ignored.

Integration with the share and export functionality

Custom icon packs are also supported by the Sharing feature, where they will be shown in the note tree. However, in order for an icon pack to be visible to the share function, the icon pack note must also be shared.

If you are using a custom share theme, make sure it supports the iconPackCss, otherwise icons will not show up. Check the original share template source code for reference.

Custom icon packs will also be preserved when Exporting static HTML for web publishing. In this case, there's no requirement to make the icon pack shared.

What happens if I remove an icon pack

If an icon pack is removed or disabled (by removing or altering its #iconPack label), all the notes that use this icon pack will show in the Note Tree with no icon. This won't cause any issues apart from looking strange.

The solution is to replace the icons with some else, try using Search which supports bulk actions, to identify the notes with the now deleted icon pack (by looking for the prefix) and changing or removing their iconClass.