diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Theme development/Creating an icon pack.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Theme development/Creating an icon pack.html index d5649a2028..301602420c 100644 --- a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Theme development/Creating an icon pack.html +++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Theme development/Creating an icon pack.html @@ -1,100 +1,120 @@ -

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. +
  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. +
  3. Create a manifest JSON that maps icon ids to glyphs and search terms.
    4. +
  4. Create a Trilium note of type Code, set language to JSON, paste the manifest + as the note content.
    5. +
  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. +
  6. Add the label #iconPack=<prefix> to + the note (prefix: alphanumeric, hyphen, underscore only).
    7. +
  7. Refresh the client and verify the icon pack appears in the icon selector.
    8. +
+

Verify the icon set

The first step is to analyze if the icon set being packed can be integrated into Trilium.

Trilium only supports font-based icon sets, with the following formats:

- - - - - - - - - - - - - - - - - - - - - - - - - -
ExtensionMIME typeDescription
.woff2 - font/woff2 - Recommended due to great compression (low size).
.woff - font/woff - Higher compatibility, but the font file is bigger.
.ttf - font/ttf - Most common, but highest font size.
- -

Unsupported formats

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
ExtensionMIME typeDescription
.woff2 + font/woff2 + Recommended due to great compression (low size).
.woff + font/woff + Higher compatibility, but the font file is bigger.
.ttf + font/ttf + Most common, but highest font size.
+

Trilium does not support the following formats:

In this case, the font must be manually converted to one of the supported formats (ideally .woff2).

-

Prerequisites

-

In order to create a new icon pack from a set of icons, it must meet the - following criteria:

-
    -
  1. It must have a web font of the supported format (see above).
    2. -
  2. It must have some kind of list, containing the name of each icon and the - corresponding Unicode code point. If this is missing, icon fonts usually - ship with a .css file that can be used to - extract the icon names from.
    3. -
-

Step-by-step process

-

As an example throughout this page, we are going to go through the steps - of integrating Phosphor Icons.

-

Creating the manifest

-

This is the most difficult part of creating an icon pack, since it requires - processing of the icon list to match Trilium's format.

-

The icon pack manifest is a JSON file with the following structure:

{
-	"icons": {
-		"bx-ball": {
-			"glyph": "\ue9c2",
-			"terms": [ "ball" ]
-		},
-		"bxs-party": {
-			"glyph": "\uec92",
-			"terms": [ "party" ]
-		}
-	}
-}
+

Manifest format

+

The manifest is a JSON object with an icons map. + Each entry key is the CSS/class id you will use (Trilium uses the CSS class + when rendering). Value object:

-

In order to generate this manifest, generally a script is needed that - processes an already existing list. In the case of Phosphor Icons, the - icon list comes in a file called selection.json with - the following format:

{
+
Example minimal manifest:
{
+  "icons": {
+    "ph-acorn": {
+      "glyph": "\uea3f",
+      "terms": ["acorn", "nut"]
+    },
+    "ph-book": {
+      "glyph": "\uea40",
+      "terms": ["book", "read"]
+    }
+  }
+}

+
+
Concrete example: Phosphor Icons

+
Phosphor Icons provide a
+  selection.jsonthat includes properties.code (the
+    codepoint) and properties.name (the icon
+    name). The goal: convert that into Trilium's manifest.

+
Sample selection.json excerpt:
{
   "icons": [
     {
       "icon": {
@@ -121,9 +141,9 @@
     /* [...] */
   ]
 }

-
As such, we can write a Node.js script to automatically process the manifest
-  file:
import { join } from "node:path";
-import { readFileSync } from "node:fs";
+
A tiny Node.js script to produce the manifest (place selection.json in
+  the same directory and run with Node 20+):
import { join } from "node:path";
+import { readFileSync, writeFileSync } from "node:fs";
 
 function processIconPack(packName) {
     const path = join(packName);
@@ -143,12 +163,19 @@ function processIconPack(packName) {
         };
     }
 
-    return JSON.stringify({
-        icons
-    }, null, 2);
+    writeFileSync("manifest.json", JSON.stringify(icons, null, 2), "utf8");
+    console.log("manifest.json created");
 }
 
-console.log(processIconPack("light"));

+processIconPack("light");

+
What to do with the script:

+

As a more compact alternative, provide the un-escaped character directly, as UTF-8 is supported.

-

Creating the icon pack

-
    -
  1. Create a note of type Code.
    2. -
  2. Set the language to JSON.
    3. -
  3. Copy and paste the manifest generated in the previous step as the content - of this note.
    4. -
  4. Go to the note attachment and upload the - font file (in .woff2, .woff, - .ttf) format. -
      -
    1. Trilium identifies the font to use from attachments via the MIME type, - make sure the MIME type is displayed correctly after uploading the attachment - (for example font/woff2).
      2. -
    2. Make sure the role appears as file, - otherwise the font will not be identified.
      3. -
    3. Multiple attachments are supported, but only one font will actually be - used in Trilium's order of preference: .woff2, - .woff, .ttf. As such, there's not - much reason to upload more than one font per icon pack.
      4. -
    -
    5. -
  5. Go back to the note and rename it. The name of the note will also be the - name of the icon pack as displayed in the list of icons.
    6. -

Assigning the prefix

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 @@ -203,6 +204,34 @@ console.log(processIconPack("light")); 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

+
    +
  1. Create a note of type Code.
    2. +
  2. Set the language to JSON.
    3. +
  3. Rename the note. The name of the note will also be the name of the icon + pack as displayed in the list of icons.
    4. +
  4. Copy and paste the manifest generated in the previous step as the content + of this note.
    5. +
  5. Go to the note attachment and upload the + font file (in .woff2, .woff, + .ttf) format. +
      +
    1. Trilium identifies the font to use from attachments via the MIME type, + make sure the MIME type is displayed correctly after uploading the attachment + (for example font/woff2).
      2. +
    2. Make sure the role appears as file, + otherwise the font will not be identified.
      3. +
    3. Multiple attachments are supported, but only one font will actually be + used in Trilium's order of preference: .woff2, + .woff, .ttf. As such, there's not + much reason to upload more than one font per icon pack.
      4. +
    +
    6. +
  6. Add label: #iconPack=<prefix> (for + Phosphor example: #iconPack=ph).
    7. +

Final steps

Troubleshooting

If the icon pack doesn't show up, look through the Backend (server) logs for clues.

\ No newline at end of file diff --git a/docs/User Guide/!!!meta.json b/docs/User Guide/!!!meta.json index f9136647f9..dcd9086dd6 100644 --- a/docs/User Guide/!!!meta.json +++ b/docs/User Guide/!!!meta.json @@ -12408,14 +12408,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..5b18610b72 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 custom icon pack. For a general description of how to use already existing icon packs, see Icon Packs. -## 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=` to the note (prefix: alphanumeric, hyphen, underscore only). +7. Refresh the client and verify the icon pack appears in the icon selector. + +## Verify the icon set The first step is to analyze if the icon set being packed can be integrated into Trilium. @@ -14,8 +26,6 @@ Trilium only supports **font-based icon sets**, with the following formats: | `.woff` | `font/woff` | Higher compatibility, but the font file is bigger. | | `.ttf` | `font/ttf` | Most common, but highest font size. | -## Unsupported formats - Trilium **does not** support the following formats: * SVG-based fonts. @@ -26,46 +36,42 @@ Trilium **does not** support the following formats: In this case, the font must be manually converted to one of the supported formats (ideally `.woff2`). -## Prerequisites +## Manifest format -In order to create a new icon pack from a set of icons, it must meet the following criteria: +The manifest is a JSON object with an `icons` map. Each entry key is the CSS/class id you will use (Trilium uses the CSS class when rendering). Value object: -1. It must have a web font of the supported format (see above). -2. It must have some kind of list, containing the name of each icon and the corresponding Unicode code point. If this is missing, icon fonts usually ship with a `.css` file that can be used to extract the icon names from. +* glyph: the single character (the glyph) — can be the escaped Unicode (e.g. "\\ue9c2") or the literal character. +* terms: array of search aliases; the first term is used as display name in the selector. -## Step-by-step process +Example minimal manifest: -As an example throughout this page, we are going to go through the steps of integrating [Phosphor Icons](https://phosphoricons.com/). - -### Creating the manifest - -This is the most difficult part of creating an icon pack, since it requires processing of the icon list to match Trilium's format. - -The icon pack manifest is a JSON file with the following structure: - -```json +``` { - "icons": { - "bx-ball": { - "glyph": "\ue9c2", - "terms": [ "ball" ] - }, - "bxs-party": { - "glyph": "\uec92", - "terms": [ "party" ] - } - } + "icons": { + "ph-acorn": { + "glyph": "\uea3f", + "terms": ["acorn", "nut"] + }, + "ph-book": { + "glyph": "\uea40", + "terms": ["book", "read"] + } + } } ``` -* The JSON example is a sample from the Boxicons font. -* This is simply a mapping between the CSS classes (`bx-ball`), to its corresponding code point in the font (`\ue9c2`) and the terms/aliases used for search purposes. -* Note that it's also possible to use the unescaped glyph inside the JSON. It will appear strange (e.g. ), but it will be rendered properly regardless. -* The first term is also considered the “name” of the icon, which is displayed while hovering over it in the icon selector. +> [!NOTE] +> * You can supply glyph as the escaped `\uXXXX` sequence or as the actual UTF‑8 character. +> * It is also possible to use the unescaped glyph inside the JSON. It will appear strange (e.g. ), but it will be rendered properly regardless. +> * The manifest keys (e.g. `ph-acorn`) should match the class names used by the font (prefix + name is a common pattern). -In order to generate this manifest, generally a script is needed that processes an already existing list. In the case of Phosphor Icons, the icon list comes in a file called `selection.json` with the following format: +## Concrete example: Phosphor Icons -```json +[Phosphor Icons](https://phosphoricons.com/) provide a `selection.json` that includes `properties.code` (the codepoint) and `properties.name` (the icon name). The goal: convert that into Trilium's manifest. + +Sample `selection.json` excerpt: + +``` { "icons": [ { @@ -95,11 +101,11 @@ In order to generate this manifest, generally a script is needed that processes } ``` -As such, we can write a Node.js script to automatically process the manifest file: +A tiny Node.js script to produce the manifest (place `selection.json` in the same directory and run with Node 20+): ```javascript import { join } from "node:path"; -import { readFileSync } from "node:fs"; +import { readFileSync, writeFileSync } from "node:fs"; function processIconPack(packName) { const path = join(packName); @@ -119,14 +125,19 @@ function processIconPack(packName) { }; } - return JSON.stringify({ - icons - }, null, 2); + writeFileSync("manifest.json", JSON.stringify(icons, null, 2), "utf8"); + console.log("manifest.json created"); } -console.log(processIconPack("light")); +processIconPack("light"); ``` +What to do with the script: + +* Put `selection.json` and `build-manifest.js` in a folder. +* Run: node build-manifest.js +* The script writes `manifest.json` — open it, verify contents, then copy into a Trilium Code note (language: JSON). + > [!TIP] > **Mind the escape format when processing CSS** > @@ -134,17 +145,6 @@ console.log(processIconPack("light")); > > As a more compact alternative, provide the un-escaped character directly, as UTF-8 is supported. -### Creating the icon pack - -1. Create a note of type _Code_. -2. Set the language to _JSON_. -3. Copy and paste the manifest generated in the previous step as the content of this note. -4. Go to the [note attachment](../Basic%20Concepts%20and%20Features/Notes/Attachments.md) and upload the font file (in `.woff2`, `.woff`, `.ttf`) format. - 1. Trilium identifies the font to use from attachments via the MIME type, make sure the MIME type is displayed correctly after uploading the attachment (for example `font/woff2`). - 2. Make sure the `role` appears as `file`, otherwise the font will not be identified. - 3. Multiple attachments are supported, but only one font will actually be used in Trilium's order of preference: `.woff2`, `.woff`, `.ttf`. As such, there's not much reason to upload more than one font per icon pack. -5. Go back to the note and rename it. The name of the note will also be the name of the icon pack as displayed in the list of icons. - ### Assigning the prefix 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. @@ -158,6 +158,18 @@ For our example with Phosphor Icons, we can use the `ph` prefix since it also ma > [!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 Backend (server) logs. +## Creating the Trilium icon pack note + +1. Create a note of type _Code_. +2. Set the language to _JSON_. +3. Rename the note. The name of the note will also be the name of the icon pack as displayed in the list of icons. +4. Copy and paste the manifest generated in the previous step as the content of this note. +5. Go to the [note attachment](../Basic%20Concepts%20and%20Features/Notes/Attachments.md) and upload the font file (in `.woff2`, `.woff`, `.ttf`) format. + 1. Trilium identifies the font to use from attachments via the MIME type, make sure the MIME type is displayed correctly after uploading the attachment (for example `font/woff2`). + 2. Make sure the `role` appears as `file`, otherwise the font will not be identified. + 3. Multiple attachments are supported, but only one font will actually be used in Trilium's order of preference: `.woff2`, `.woff`, `.ttf`. As such, there's not much reason to upload more than one font per icon pack. +6. Add label: `#iconPack=` (for Phosphor example: `#iconPack=ph`). + ### Final steps * [Refresh the client](../Troubleshooting/Refreshing%20the%20application.md)