While the sharing feature is powerful, it has some limitations:
-
Code Notes: No syntax highlighting.
-
Static Note Tree
+
Code Notes: No syntax highlighting.
+
Static Note Tree
-
Protected Notes: Cannot be shared.
-
Include Notes: Not supported.
+
Protected Notes: Cannot be shared.
+
Include Notes: Not supported.
Some of these limitations may be addressed in future updates.
Prerequisites
@@ -186,7 +181,7 @@ class="image">
is necessary because the notes will be hosted from the server.
Sharing a note
-
+
Enable Sharing: To share a note, toggle the Shared switch
within the note's interface. Once sharing is enabled, an URL will appear,
which you can click to access the shared note.
Access the Shared Note: The link provided will open the
- note in your browser. If your server is not configured with a public IP,
- the URL will refer to localhost (127.0.0.1).
+
+
Access the Shared Note: The link provided will open the
+ note in your browser. If your server is not configured with a public IP,
+ the URL will refer to localhost (127.0.0.1).
+
Sharing a note subtree
When you share a note, you actually share the entire subtree of notes
@@ -223,13 +220,12 @@ class="image">
The default design should be a good starting point, but you can customize
it using your own CSS:
-
Custom CSS: Link a CSS Custom CSS: Link a CSS Code note to the shared page by adding
a ~shareCss relation to the note. If you want this style to
apply to the entire subtree, make the label inheritable. You can hide the
CSS code note from the tree navigation by adding the #shareHiddenFromTree label.
-
Omitting Default CSS: For extensive styling changes,
+
Omitting Default CSS: For extensive styling changes,
use the #shareOmitDefaultCss label to avoid conflicts with Trilium's
default stylesheet.
@@ -247,22 +243,22 @@ class="image">
itself.
The #shareHtmlLocation label accepts values in the format location:position:
-
Locations: head, body, content
+
Locations: head, body, content
-
Positions: start, end
+
Positions: start, end
For example:
-
#shareHtmlLocation=head:start - Injects HTML at the beginning
+
#shareHtmlLocation=head:start - Injects HTML at the beginning
of the <head> section
-
#shareHtmlLocation=head:end - Injects HTML at the end of the <head> section
+
#shareHtmlLocation=head:end - Injects HTML at the end of the <head> section
(default)
-
#shareHtmlLocation=body:start - Injects HTML at the beginning
+
#shareHtmlLocation=body:start - Injects HTML at the beginning
of the <body> section
-
#shareHtmlLocation=content:start - Injects HTML at the beginning
+
#shareHtmlLocation=content:start - Injects HTML at the beginning
of the content area
-
#shareHtmlLocation=content:end - Injects HTML at the end of
+
#shareHtmlLocation=content:end - Injects HTML at the end of
the content area
If no location is specified, the HTML will be injected at content:end by
@@ -280,18 +276,17 @@ for (const attr of parentNote.attributes) {
This will change the URL to http://domain.tld/share/highlighting.
Important:
-
Ensure that aliases are unique.
-
Using slashes (/) within aliases to create subpaths is not
+
Ensure that aliases are unique.
+
Using slashes (/) within aliases to create subpaths is not
supported.
Setting a custom favicon
@@ -314,92 +309,91 @@ for (const attr of parentNote.attributes) {
When viewed, the list of shared roots will be displayed at the bottom of
the note.
Attribute reference
-
-
-
-
-
Attribute
-
Description
-
-
-
-
-
shareHiddenFromTree
-
-
this note is hidden from left navigation tree, but still accessible with
- its URL
-
-
-
shareExternalLink
-
-
note will act as a link to an external website in the share tree
-
-
-
shareAlias
-
-
define an alias using which the note will be available under https://your_trilium_host/share/[your_alias]
-
-
-
-
shareOmitDefaultCss
-
-
default share page CSS will be omitted. Use when you make extensive styling
- changes.
-
-
-
shareRoot
-
-
marks note which is served on /share root.
-
-
-
shareDescription
-
-
define text to be added to the HTML meta tag for description
-
-
-
shareRaw
-
-
Note will be served in its raw format, without HTML wrapper. See also
- Serving directly the content of a note for an alternative method
- without setting an attribute.
-
-
-
shareDisallowRobotIndexing
-
-
-
Indicates to web crawlers that the page should not be indexed of this
- note by:
-
-
Setting the X-Robots-Tag: noindex HTTP header.
-
Setting the noindex, follow meta tag.
-
-
-
-
-
shareCredentials
-
-
require credentials to access this shared note. Value is expected to be
- in format username:password. Don't forget to make this inheritable
- to apply to child-notes/images.
-
-
-
shareIndex
-
-
Note with this label will list all roots of shared notes.
-
-
-
shareHtmlLocation
-
-
defines where custom HTML injected via ~shareHtml relation
- should be placed. Applied to the HTML snippet note itself. Format: location:position where
- location is head, body, or content and
- position is start or end. Defaults to content:end.
-
-
-
-
-
Credits
+
+
+
+
Attribute
+
Description
+
+
+
+
+
shareHiddenFromTree
+
+
this note is hidden from left navigation tree, but still accessible with
+ its URL
+
+
+
shareExternalLink
+
+
note will act as a link to an external website in the share tree
+
+
+
shareAlias
+
+
define an alias using which the note will be available under https://your_trilium_host/share/[your_alias]
+
+
+
+
shareOmitDefaultCss
+
+
default share page CSS will be omitted. Use when you make extensive styling
+ changes.
+
+
+
shareRoot
+
+
marks note which is served on /share root.
+
+
+
shareDescription
+
+
define text to be added to the HTML meta tag for description
+
+
+
shareRaw
+
+
Note will be served in its raw format, without HTML wrapper. See also
+ Serving directly the content of a note for an alternative method
+ without setting an attribute.
+
+
+
shareDisallowRobotIndexing
+
+
+
Indicates to web crawlers that the page should not be indexed of this
+ note by:
+
+
Setting the X-Robots-Tag: noindex HTTP header.
+
Setting the noindex, follow meta tag.
+
+
+
+
+
shareCredentials
+
+
require credentials to access this shared note. Value is expected to be
+ in format username:password. Don't forget to make this inheritable
+ to apply to child-notes/images.
+
+
+
shareIndex
+
+
Note with this label will list all roots of shared notes.
+
+
+
shareHtmlLocation
+
+
defines where custom HTML injected via ~shareHtml relation
+ should be placed. Applied to the HTML snippet note itself. Format: location:position where
+ location is head, body, or content and
+ position is start or end. Defaults to content:end.
+
+
+
+
+
Credits
Since v0.95.0, a new theme was introduced (and enabled by default) which
greatly improves the visual aspect of the Share feature, as well as its
functionality (such as mobile support, dark/light mode, collapsible tree,
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Collections.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Collections.html
index 308dbe477..fa40dcfbd 100644
--- a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Collections.html
+++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Collections.html
@@ -1,91 +1,85 @@
Collections are a unique type of notes that don't have a content, but
instead display its child notes in various presentation methods.
Main collections
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Calendar
- which displays a week, month or year calendar with the notes being shown
- as events. New events can be added easily by dragging across the calendar.
-
-
-
-
-
-
-
-
-
-
Table
- displays each note as a row in a table, with Promoted Attributes being shown as well.
- This makes it easy to visualize attributes of notes, as well as making
- them easily editable.
-
-
-
-
-
-
-
-
Kanban Board
- displays notes in columns, grouped by the value of a label. Items and
- columns can easily be created or dragged around to change their status.
-
-
-
-
-
-
-
-
Geo Map
- which displays a geographical map in which the notes are represented as
- markers/pins on the map. New events can be easily added by pointing on
- the map.
-
-
-
-
-
-
-
-
-
-
Presentation
- which shows each note as a slide and can be presented full-screen with
- smooth transitions or exported to PDF for sharing.
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Calendar
+ which displays a week, month or year calendar with the notes being shown
+ as events. New events can be added easily by dragging across the calendar.
+
+
+
+
+
+
+
+
Table
+ displays each note as a row in a table, with Promoted Attributes being shown as well.
+ This makes it easy to visualize attributes of notes, as well as making
+ them easily editable.
+
+
+
+
+
+
+
+
Kanban Board
+ displays notes in columns, grouped by the value of a label. Items and
+ columns can easily be created or dragged around to change their status.
+
+
+
+
+
+
+
+
Geo Map
+ which displays a geographical map in which the notes are represented as
+ markers/pins on the map. New events can be easily added by pointing on
+ the map.
+
+
+
+
+
+
+
+
Presentation
+ which shows each note as a slide and can be presented full-screen with
+ smooth transitions or exported to PDF for sharing.
+
+
+
+
Classic collections
Classic collections are read-only mode and compiles the contents of all
child notes into one continuous view. This makes it ideal for reading extensive
information broken into smaller, manageable segments.
Grid View which
is the default presentation method for child notes (see Note List), where the notes are displayed
as tiles with their title and content being visible.
List View is
similar to Grid View,
but it displays the notes one under the other with the content being expandable/collapsible,
but also works recursively.
@@ -99,8 +93,8 @@
collection (e.g. from Kanban Board to a Calendar), see the dedicated Collections tab
in the Ribbon.
Archived notes
-
By default, archived notes will
- not be shown in collections. This behaviour can be changed by going to Collection Properties in
+
By default, archived notes will not be
+ shown in collections. This behaviour can be changed by going to Collection Properties in
the Ribbon and
checking Show archived notes.
Archived notes will be generally indicated by being greyed out as opposed
@@ -109,8 +103,8 @@
Adding a description to a collection
To add a text before the collection, for example to describe it:
In the Ribbon,
go to Basic Properties and select Collection as the note
type.
-
Still in the ribbon, go to Collection Properties and select the
+
Still in the ribbon, go to Collection Properties and select the
desired view type.
-
Consult the help page of the corresponding view type in order to understand
+
Consult the help page of the corresponding view type in order to understand
how to configure them.
Under the hood
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Collections/Calendar.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Collections/Calendar.html
index d7be31c1f..160cee491 100644
--- a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Collections/Calendar.html
+++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Collections/Calendar.html
@@ -283,8 +283,8 @@
not having a dateNote attribute. Children of the child notes
will not be displayed.
-
+
Using a different attribute as event title
By default, events are displayed on the calendar by their note title.
@@ -335,8 +335,8 @@ width="1217" height="724">
#startDate=2025-02-14 #endDate=2025-02-15 ~for=@John Smith ~for=@Jane Doe #calendar:title="for"
- 
- 
- 
- 
- 
- 
+
+