- | - | 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 - | -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 + | +Not supported. | ++ |
| File + | +Basic interaction (downloading the file). | +
+
|
+
While the sharing feature is powerful, it has some limitations:
Some of these limitations may be addressed in future updates.
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.
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).
When you share a note, you actually share the entire subtree of notes @@ -212,11 +209,11 @@ class="image"> public.
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.The #shareHtmlLocation label accepts values in the format location:position:
head, body, content
+ head, body, content
start, end
+ 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 areaIf no location is specified, the HTML will be injected at content:end by
@@ -290,16 +286,16 @@ for (const attr of parentNote.attributes) {
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.| 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. | -
#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. |
-
| 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. | +
#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. |
+
It's possible to adjust the logo which is displayed on the top-left of the left pane.
-| Attribute | -Description | -
|---|---|
~shareLogo
- |
- Relation set to an image to use as logo. The image must be part of the - share tree (it can be hidden if needed). | -
#shareLogoWidth
- |
- The width (in pixels, without unit) to set for the logo. Default is 53. |
-
#shareLogoHeight
- |
- The height (in pixels, without unit) to set for the logo. Default is 40. |
-
#shareRootLink
- |
- URL to navigate to when the logo is pressed. | -
| Attribute | -Description | -
|---|---|
#shareOpenGraphColor
- |
- This adjusts the theme-color meta-property. |
-
#shareOpenGraphURL
- |
- This adjusts the og:url and twitter:url meta-properties. |
-
#shareOpenGraphDomain
- |
- Adjusts the twitter:domain meta-property. |
-
#shareOpenGraphImage
- ~shareOpenGraphImage
- |
- Can be either a label, case in which the value is passed on as-is, or
- it can be a relation to an image File.
- This controls the og:image meta-property. |
-
| Attribute | +Description | +
|---|---|
~shareLogo
+ |
+ Relation set to an image to use as logo. The image must be part of the + share tree (it can be hidden if needed). | +
#shareLogoWidth
+ |
+ The width (in pixels, without unit) to set for the logo. Default is 53. |
+
#shareLogoHeight
+ |
+ The height (in pixels, without unit) to set for the logo. Default is 40. |
+
#shareRootLink
+ |
+ URL to navigate to when the logo is pressed. | +
| Attribute | +Description | +
|---|---|
#shareOpenGraphColor
+ |
+ This adjusts the theme-color meta-property. |
+
#shareOpenGraphURL
+ |
+ This adjusts the og:url and twitter:url meta-properties. |
+
#shareOpenGraphDomain
+ |
+ Adjusts the twitter:domain meta-property. |
+
#shareOpenGraphImage
+ ~shareOpenGraphImage
+ |
+ Can be either a label, case in which the value is passed on as-is, or
+ it can be a relation to an image File.
+ This controls the og:image meta-property. |
+
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/Reverse proxy configuration.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Sharing/Reverse proxy configuration.html index 220ae8b74..5f1bafa0c 100644 --- a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Sharing/Reverse proxy configuration.html +++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Sharing/Reverse proxy configuration.html @@ -6,18 +6,13 @@ reverse_proxy /share http://localhost:8080/share }
This is for newer versions where the share functionality is isolated,
- for older versions it's required to also include /assets.
- [1]
-
+ for older versions it's required to also include /assets.[1]