From d611591e1a3d45b483aa171d9a898a3081eb5565 Mon Sep 17 00:00:00 2001
From: Elian Doran Trilium supports configuration via a file named The configuration file is not located in the same directory as the application.
+ Instead, the Configuration values are loaded in the following order of precedence (highest
to lowest): While the sharing feature is powerful, it has some limitations: Some of these limitations may be addressed in future updates. To use the sharing feature, you must have a Server Installation of Trilium.
This is necessary because the notes will be hosted from the server. Enable Sharing: To share a note, toggle the config.ini
and
environment variables. This document provides a comprehensive reference
for all configuration options.Location of the configuration file
+config.ini
is located in the Data directory. As such, the configuration
+ file is only available after starting the application and creating a database.Configuration Precedence
-
-
Features, interaction and limitations
+ Features, interaction and limitations
-
By note type
-
-
+
-
-
-
-
- Supported features
- Limitations
-
-
- Text
-
-
-
-
-
-
-
-
-
-
-
- Code
-
-
-
-
-
-
-
-
-
-
-
- Saved Search
-
- Not supported.
-
-
-
- Relation Map
-
- Not supported.
-
-
-
- Note Map
-
- Not supported.
-
-
-
- Render Note
-
- Not supported.
-
-
-
- Collections
-
-
-
-
-
-
-
-
-
-
-
- Mermaid Diagrams
-
-
-
-
-
-
-
-
-
-
-
- Canvas
-
-
-
-
-
-
-
-
-
-
-
- Web View
-
- Not supported.
-
-
-
- Mind Map
-
- The diagram is displayed as a vector image.
-
-
-
-
-
-
- Geo Map View
-
- Not supported.
-
-
-
-
- File
-
- Basic interaction (downloading the file).
-
-
-
-
-
+
+
+
+
+
+
+ Supported features
+ Limitations
+
+
+ Text
+
+
+
+
+
+
+
+
+
+
+
+ Code
+
+
+
+
+
+
+
+
+
+
+
+ Saved Search
+
+ Not supported.
+
+
+
+ Relation Map
+
+ Not supported.
+
+
+
+ Note Map
+
+ Not supported.
+
+
+
+ Render Note
+
+ Not supported.
+
+
+
+ Collections
+
+
+
+
+
+
+
+
+
+
+
+ Mermaid Diagrams
+
+
+
+
+
+
+
+
+
+
+
+ Canvas
+
+
+
+
+
+
+
+
+
+
+
+ Web View
+
+ Not supported.
+
+
+
+ Mind Map
+
+ The diagram is displayed as a vector image.
+
+
+
+
+
+
+ Geo Map View
+
+ Not supported.
+
+
+
+
+ File
+
+ Basic interaction (downloading the file).
+
+
+
+
+
-
Prerequisites
How to Share a Note
+ Sharing a note
-
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)
.
localhost (127.0.0.1)
.When you share a note, you actually share the entire subtree of notes beneath it. If the note has child notes, they will also be included in the shared content. For example, sharing the "Formatting" subtree will display a page with basic navigation for exploring all the notes within that subtree.
-You can view a list of all shared notes by clicking on "Show Shared Notes - Subtree." This allows you to manage and navigate through all the notes - you have made public.
-Shared notes are published on the open internet and can be accessed by anyone with the URL. The URL's randomness does not provide security, so it is crucial not to share sensitive information through this feature.
-To protect shared notes with a username and password, you can use the #shareCredentials
attribute.
Add this label to the note with the format #shareCredentials="username:password"
.
To protect an entire subtree, make sure the label is inheritable.
The default design should be a good starting point, but you can customize it using your own CSS:
~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.#shareOmitDefaultCss
label to avoid conflicts with Trilium's
default stylesheet.Shared notes typically have URLs like http://domain.tld/share/knvU8aJy4dJ7
,
where the last part is the note's ID. You can make these URLs more user-friendly
by adding the #shareAlias
label to individual notes (e.g., #shareAlias=highlighting
).
This will change the URL to http://domain.tld/share/highlighting
.
Important:
/
) within aliases to create subpaths is not
+ /
) within aliases to create subpaths is not
supported.All shared notes are grouped under an automatically managed "Shared Notes" - section. From here, you can view, share, or unshare notes by moving or - cloning them within this section.
-
-
-
To customize the favicon for your shared pages, create a relation ~shareFavicon
pointing
to a file note containing the favicon (e.g., in .ico
format).
You can designate a specific note or folder as the root of your shared
content by adding the #shareRoot
label. This note will be linked
when visiting [http://domain.tld/share](http://domain/share)
,
- making it easier to use Trilium as a fully-fledged website. Consider combining
- this with the #shareIndex
label, which will display a list of
- all shared notes.
When accessing a share, the sub-notes will be displayed in a tree on the + left. But since multiple note trees can be shared, it might be useful to + display a list of all the different share trees.
+To do so, create a shared text note and apply the shareIndex
label.
+ When viewed, the list of shared roots will be displayed at the bottom of
+ the note.
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: -
|
-
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. | -
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: +
|
+
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. | +
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/Advanced Usage/Sharing_shared-list.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Sharing_shared-list.png
deleted file mode 100644
index 8002303f859de7baeba88b7a15573e87c83dca8a..0000000000000000000000000000000000000000
GIT binary patch
literal 0
HcmV?d00001
literal 8948
zcmbt)XH*nhw{43kK@iCT0!j`|YCu%dAqzB;p~ j2H)`k6q*ROqf%7lBs98w;9#t_GkA<}t8X1p#2a
zAp_tv+DrvEbG`t){_OIf%LPlol1&iczlMY6HL(oouyJz>y%M8AA7Q}{yv86QW4e48
zgx%UZ1nB-f*u(G3tHH0
Since TriliumNext v0.90.12, Trilium will try to offer syntax highlighting to the code block. Note that the syntax highlighting mechanism is slightly diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Lists.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Lists.html index 97ddf6238..ab94a50a7 100644 --- a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Lists.html +++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Lists.html @@ -1,15 +1,15 @@
There are three types of lists supported by text notes:
For bulleted and numbered lists, it's possible to configure an alternative
marker such as squares or Roman numbering by pressing the
- icon. For numbered lists, it's also possible to specify the number to
start at or whether to count in reverse order.
1.
or 1)
followed
by a space;[ ]
for an unchecked item or [x]
for
+ - [ ]
for an unchecked item or [x]
for
a checked item.The same principle applies to all three list types (bullet, numbered and - to-do).
\ No newline at end of file + to-do). +- [ ]
for an
+ unchecked item or [x]
for a checked item while on an empty paragraph.j2H)`k6q*ROqf%7lBs98w;9#t_GkA<}t8X1p#2a
zAp_tv+DrvEbG`t){_OIf%LPlol1&iczlMY6HL(oouyJz>y%M8AA7Q}{yv86QW4e48
zgx%UZ1nB-f*u(G3tHH0 Indicates to web crawlers that the page should not be indexed of this note by: Indicates to web crawlers that the page should not be indexed of this note by: j2H)`k6q*ROqf%7lBs98w;9#t_GkA<}t8X1p#2a
zAp_tv+DrvEbG`t){_OIf%LPlol1&iczlMY6HL(oouyJz>y%M8AA7Q}{yv86QW4e48
zgx%UZ1nB-f*u(G3tHH0
+ Supported features Limitations Text Code Saved Search Not supported. Relation Map Not supported. Note Map Not supported. Render Note Not supported. Collections Mermaid Diagrams Canvas Web View Not supported. Mind Map The diagram is displayed as a vector image. Geo Map View Not supported. File Basic interaction (downloading the file).
While the sharing feature is powerful, it has some limitations:
@@ -31,32 +31,32 @@ Some of these limitations may be addressed in future updates.
To use the sharing feature, you must have a Server Installation of Trilium. This is necessary because the notes will be hosted from the server.
-## How to Share a Note
+## Sharing a note
1. **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.

2. **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
+## Sharing a note subtree
When you share a note, you actually share the entire subtree of notes beneath it. If the note has child notes, they will also be included in the shared content. For example, sharing the "Formatting" subtree will display a page with basic navigation for exploring all the notes within that subtree.
-## Viewing All Shared Notes
+## Viewing and managing shared notes
-You can view a list of all shared notes by clicking on "Show Shared Notes Subtree." This allows you to manage and navigate through all the notes you have made public.
+You can view a list of all shared notes by clicking on "Show Shared Notes Subtree" in the Global menu. This allows you to manage and navigate through all the notes you have made public.
-## Security Considerations
+## Security considerations
Shared notes are published on the open internet and can be accessed by anyone with the URL. The URL's randomness does not provide security, so it is crucial not to share sensitive information through this feature.
-### Password Protection
+### Password protection
To protect shared notes with a username and password, you can use the `#shareCredentials` attribute. Add this label to the note with the format `#shareCredentials="username:password"`. To protect an entire subtree, make sure the label is [inheritable](Attributes/Attribute%20Inheritance.md).
-## Advanced Sharing Options
+## Advanced sharing options
-### Customizing the Appearance of Shared Notes
+### Customizing the appearance of shared notes
The default design should be a good starting point, but you can customize it using your own CSS:
@@ -78,7 +78,7 @@ for (const attr of parentNote.attributes) {
}
```
-### Creating Human-Readable URL Aliases
+### Creating human-readable URL aliases
Shared notes typically have URLs like `http://domain.tld/share/knvU8aJy4dJ7`, where the last part is the note's ID. You can make these URLs more user-friendly by adding the `#shareAlias` label to individual notes (e.g., `#shareAlias=highlighting`). This will change the URL to `http://domain.tld/share/highlighting`.
@@ -87,23 +87,26 @@ Shared notes typically have URLs like `http://domain.tld/share/knvU8aJy4dJ7`, wh
1. Ensure that aliases are unique.
2. Using slashes (`/`) within aliases to create subpaths is not supported.
-### Viewing and Managing Shared Notes
-
-All shared notes are grouped under an automatically managed "Shared Notes" section. From here, you can view, share, or unshare notes by moving or cloning them within this section.
-
-
-
-### Setting a Custom Favicon
+### Setting a custom favicon
To customize the favicon for your shared pages, create a relation `~shareFavicon` pointing to a file note containing the favicon (e.g., in `.ico` format).
-### Sharing a Note as the Root
+### Sharing a note as the root
-You can designate a specific note or folder as the root of your shared content by adding the `#shareRoot` label. This note will be linked when visiting `[http://domain.tld/share](http://domain/share)`, making it easier to use Trilium as a fully-fledged website. Consider combining this with the `#shareIndex` label, which will display a list of all shared notes.
+You can designate a specific note or folder as the root of your shared content by adding the `#shareRoot` label. This note will be linked when visiting `[http://domain.tld/share](http://domain/share)`, making it easier to use Trilium as a fully-fledged website.
+
+> [!TIP]
+> Consider combining this with the `#shareIndex` label, which will display a list of all shared notes.
+
+### Displaying an index of shared notes
+
+When accessing a share, the sub-notes will be displayed in a tree on the left. But since multiple note trees can be shared, it might be useful to display a list of all the different share trees.
+
+To do so, create a shared text note and apply the `shareIndex` label. When viewed, the list of shared roots will be displayed at the bottom of the note.
## Attribute reference
- Supported features Limitations Text Code Saved Search Not supported. Relation Map Not supported. Note Map Not supported. Render Note Not supported. Collections Mermaid Diagrams Canvas Web View Not supported. Mind Map The diagram is displayed as a vector image. Geo Map View Not supported. File Basic interaction (downloading the file).
+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
X-Robots-Tag: noindex
HTTP header.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.
## Credits
diff --git a/docs/User Guide/User Guide/Advanced Usage/Sharing_shared-list.png b/docs/User Guide/User Guide/Advanced Usage/Sharing_shared-list.png
deleted file mode 100644
index 8002303f859de7baeba88b7a15573e87c83dca8a..0000000000000000000000000000000000000000
GIT binary patch
literal 0
HcmV?d00001
literal 8948
zcmbt)XH*nhw{43kK@iCT0!j`|YCu%dAqzB;p~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
X-Robots-Tag: noindex
HTTP header.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. Bulleted lists (also known as unordered lists).
-*
Numbered lists (or ordered lists).
-*
To-do lists
+*
Bulleted lists (also known as unordered lists).
+*
Numbered lists (or ordered lists).
+*
To-do lists
-For bulleted and numbered lists, it's possible to configure an alternative marker such as squares or Roman numbering by pressing the
icon. For numbered lists, it's also possible to specify the number to start at or whether to count in reverse order.
+For bulleted and numbered lists, it's possible to configure an alternative marker such as squares or Roman numbering by pressing the
icon. For numbered lists, it's also possible to specify the number to start at or whether to count in reverse order.
## Keyboard interaction
* To create a new list:
* Bulleted list: Start a line with `*` or `-` followed by a space;
* Numbered list: Start a line with `1.` or `1)` followed by a space;
- * To-do list: Start a line with `[ ]` for an unchecked item or `[x]` for a checked item.
+ * To-do list: Start a line with `- [ ]` for an unchecked item or `[x]` for a checked item.
* To create a new item in the list, press Enter.
* To create a blank line within a list item, press Shift+Enter.
* To exit out of the list, press Enter twice.
* To merge two lists, simply delete the gap between them.
-* To create nested lists, simply use the
button (see _Indentation_ in Other features) or the Tab key. To decrease the nesting level for the current element, press Shift+Tab.
+* To create nested lists, simply use the
button (see _Indentation_ in Other features) or the Tab key. To decrease the nesting level for the current element, press Shift+Tab.
## Headings, code blocks within lists
@@ -26,10 +26,15 @@ It possible to add content-level blocks such as headings, code blocks, tables wi
| | | |
| --- | --- | --- |
| 1 |  | First, create a list. |
-| 2 |  | Press Enter to create a new list item. |
+| 2 |  | Press Enter to create a new list item. |
| 3 |  | Press Backspace to get rid of the bullet point. Notice the cursor position. |
-| 4 |
| At this point, insert any desired block-level item such as a code block. |
-| 5 |
| To continue with a new bullet point, press Enter until the cursor moves to a new blank position. |
+| 4 |
| At this point, insert any desired block-level item such as a code block. |
+| 5 |
| To continue with a new bullet point, press Enter until the cursor moves to a new blank position. |
| 6 |
| Press Enter once more to create the new bullet. |
-The same principle applies to all three list types (bullet, numbered and to-do).
\ No newline at end of file
+The same principle applies to all three list types (bullet, numbered and to-do).
+
+## To-do lists
+
+* To insert a to-do list from the keyboard, type `- [ ]` for an unchecked item or `[x]` for a checked item while on an empty paragraph.
+* To reorder the item under the cursor, press Alt+Up or Alt+Down. To reorder multiple items, select them first.
\ No newline at end of file
diff --git a/docs/User Guide/User Guide/Note Types/Text/Lists_image.png b/docs/User Guide/User Guide/Note Types/Text/Lists_image.png
index 30a9511b0818234dd0e4bb2c58ffd8aac4a276da..1282f27ec0c652a86bf05bbfaf6e514d403112ef 100644
GIT binary patch
literal 160
zcmeAS@N?(olHy`uVBq!ia0vp^!XP#aGmzZ5$U_83F&8^|hH!9j+