From 3742cd4a51c26c197dd0603dd646f20174a00678 Mon Sep 17 00:00:00 2001
From: hulmgulm Before an icon pack can be used, it needs to have a prefix defined. This
+ prefix uniquely identifies the icon pack so that it can be used throughout
+ the application. To do so, Trilium makes use of the same format that was used for the internal
+ icon pack (Boxicons). For example, when an icon from Boxicons is set, it
+ looks like this: In order for an icon pack to be recognized, the prefix must be specified
+ in the For our example with Phosphor Icons, we can use the The prefix must consist of only alphanumeric characters, hyphens and underscore.
+ If the prefix doesn't match these constraints, the icon pack will be ignored
+ and an error will be logged in [missing note]. Before an icon pack can be used, it needs to have a prefix defined. This
- prefix uniquely identifies the icon pack so that it can be used throughout
- the application. To do so, Trilium makes use of the same format that was used for the internal
- icon pack (Boxicons). For example, when an icon from Boxicons is set, it
- looks like this: In order for an icon pack to be recognized, the prefix must be specified
- in the For our example with Phosphor Icons, we can use the The prefix must consist of only alphanumeric characters, hyphens and underscore.
- If the prefix doesn't match these constraints, the icon pack will be ignored
- and an error will be logged in Backend (server) logs. If the icon pack doesn't show up, look through the Backend (server) logs for clues.Creating the icon pack
+Assigning the prefix
+#iconClass="bx bxs-sushi".
+ In this case, the icon pack prefix is bx and
+ the icon class name is bxs-sushi.#iconPack label. ph prefix
+ since it also matches the prefix set in the original CSS. So in this case
+ it would be #iconPack=ph.Creating the Trilium icon pack note
- #iconPack=<prefix> (for
+ Phosphor example: #iconPack=ph).Assigning the prefix
-#iconClass="bx bxs-sushi".
- In this case, the icon pack prefix is bx and
- the icon class name is bxs-sushi.#iconPack label. ph prefix
- since it also matches the prefix set in the original CSS. So in this case
- it would be #iconPack=ph.Final steps
- Troubleshooting
ERROR: Icon pack is missing WOFF/WOFF2/TTF attachment: Boxicons v3 400 (dup) (XRzqDQ67fHEK).
+There are multiple types of documentation for Trilium:
* The _User Guide_ represents the user-facing documentation. This documentation can be browsed by users directly from within Trilium, by pressing F1.
* The _Developer's Guide_ represents a set of Markdown documents that present the internals of Trilium, for developers.
diff --git a/docs/User Guide/!!!meta.json b/docs/User Guide/!!!meta.json
index df7c61602d..8da42b5304 100644
--- a/docs/User Guide/!!!meta.json
+++ b/docs/User Guide/!!!meta.json
@@ -12290,14 +12290,14 @@
{
"type": "relation",
"name": "internalLink",
- "value": "0vhv7lsOLy82",
+ "value": "bnyigUA2UK7s",
"isInheritable": false,
"position": 20
},
{
"type": "relation",
"name": "internalLink",
- "value": "bnyigUA2UK7s",
+ "value": "0vhv7lsOLy82",
"isInheritable": false,
"position": 30
},
diff --git a/docs/User Guide/User Guide/Theme development/Creating an icon pack.md b/docs/User Guide/User Guide/Theme development/Creating an icon pack.md
index 20bc897899..c9034bd7c0 100644
--- a/docs/User Guide/User Guide/Theme development/Creating an icon pack.md
+++ b/docs/User Guide/User Guide/Theme development/Creating an icon pack.md
@@ -1,8 +1,20 @@
# Creating an icon pack
> [!NOTE]
-> This page describes how to create custom icon packs. For a general description of how to use already existing icon packs, see Icon Packs.
+> This page explains, step‑by‑step, how to create a create a custom icon pack. For a general description of how to use already existing icon packs, see [missing note].
-## Supported formats
+First read the quick flow to get the overall steps. After that there is a concrete example (Phosphor) with a small Node.js script you can run to generate the manifest.
+
+## Quick flow (what you need to do)
+
+1. Verify the icon set is a font (one of: .woff2, .woff, .ttf).
+2. Obtain a list that maps icon names to Unicode code points (often provided as a JSON like `selection.json` or a CSS file).
+3. Create a manifest JSON that maps icon ids to glyphs and search terms.
+4. Create a Trilium note of type Code, set language to JSON, paste the manifest as the note content.
+5. Upload the font file as an attachment to the same note (MIME type must be `font/woff2`, `font/woff`, or `font/ttf` and role `file`).
+6. Add the label `#iconPack=This page explains, step‑by‑step, how to create a create a custom icon pack. For a general description of how to use already existing icon packs, - see [missing note].
+ see Icon Packs.First read the quick flow to get the overall steps. After that there is
a concrete example (Phosphor) with a small Node.js script you can run to
@@ -202,7 +202,7 @@ processIconPack("light");
The prefix must consist of only alphanumeric characters, hyphens and underscore.
If the prefix doesn't match these constraints, the icon pack will be ignored
- and an error will be logged in [missing note].
If the icon pack doesn't show up, look through the [missing note] for clues.
+ href="#root/_help_bnyigUA2UK7s">Backend (server) logs for clues.ERROR: Icon pack is missing WOFF/WOFF2/TTF attachment: Boxicons v3 400 (dup) (XRzqDQ67fHEK).
* The _User Guide_ represents the user-facing documentation. This documentation can be browsed by users directly from within Trilium, by pressing F1.
* The _Developer's Guide_ represents a set of Markdown documents that present the internals of Trilium, for developers.
diff --git a/docs/User Guide/User Guide/Theme development/Creating an icon pack.md b/docs/User Guide/User Guide/Theme development/Creating an icon pack.md
index c9034bd7c0..6adc6f9868 100644
--- a/docs/User Guide/User Guide/Theme development/Creating an icon pack.md
+++ b/docs/User Guide/User Guide/Theme development/Creating an icon pack.md
@@ -1,6 +1,6 @@
# Creating an icon pack
> [!NOTE]
-> This page explains, step‑by‑step, how to create a create a custom icon pack. For a general description of how to use already existing icon packs, see [missing note].
+> This page explains, step‑by‑step, how to create a create a custom icon pack. For a general description of how to use already existing icon packs, see Icon Packs.
First read the quick flow to get the overall steps. After that there is a concrete example (Phosphor) with a small Node.js script you can run to generate the manifest.
@@ -156,7 +156,7 @@ In order for an icon pack to be recognized, the prefix must be specified in the
For our example with Phosphor Icons, we can use the `ph` prefix since it also matches the prefix set in the original CSS. So in this case it would be `#iconPack=ph`.
> [!IMPORTANT]
-> The prefix must consist of only alphanumeric characters, hyphens and underscore. If the prefix doesn't match these constraints, the icon pack will be ignored and an error will be logged in [missing note].
+> The prefix must consist of only alphanumeric characters, hyphens and underscore. If the prefix doesn't match these constraints, the icon pack will be ignored and an error will be logged in Backend (server) logs.
## Creating the Trilium icon pack note
@@ -179,11 +179,11 @@ For our example with Phosphor Icons, we can use the `ph` prefix since it also ma
* Optionally, assign an icon from the new icon pack to this note. This icon will be used in the icon pack filter for a visual distinction.
* The icon pack can then be [exported as ZIP](../Basic%20Concepts%20and%20Features/Import%20%26%20Export.md) in order to be distributed to other users.
* It's important to note that icon packs are considered “unsafe” by default, so “Safe mode” must be disabled when importing the ZIP.
- * Consider linking new users to the [missing note] documentation in order to understand how to import and use an icon pack.
+ * Consider linking new users to the Icon Packs documentation in order to understand how to import and use an icon pack.
### Troubleshooting
-If the icon pack doesn't show up, look through the [missing note] for clues.
+If the icon pack doesn't show up, look through the Backend (server) logs for clues.
* One example is if the font could not be retrieved: `ERROR: Icon pack is missing WOFF/WOFF2/TTF attachment: Boxicons v3 400 (dup) (XRzqDQ67fHEK)`.
* Make sure the prefix is unique and not already taken by some other icon pack. When there are two icon packs with the same prefix, only one is used. The server logs will indicate if this situation occurs.
From 0c552eb0c094685af765915b7f3bb654bb5b45e9 Mon Sep 17 00:00:00 2001
From: hulmgulm This page explains, step‑by‑step, how to create a create a custom icon +
This page explains, step‑by‑step, how to create a custom icon pack. For a general description of how to use already existing icon packs, see Icon Packs.