diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Configuration (config.ini or e.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Configuration (config.ini or e.html index 1f0d6683c..1b35888ab 100644 --- a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Configuration (config.ini or e.html +++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Configuration (config.ini or e.html @@ -1,6 +1,11 @@

Trilium supports configuration via a file named config.ini and environment variables. This document provides a comprehensive reference for all configuration options.

+

Location of the configuration file

+

The configuration file is not located in the same directory as the application. + Instead, the 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

Configuration values are loaded in the following order of precedence (highest to lowest):

diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Sharing.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Sharing.html index dcb06f40d..6a86b80b1 100644 --- a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Sharing.html +++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Sharing.html @@ -6,181 +6,186 @@ class="image"> - -

Features, interaction and limitations

+

Features, interaction and limitations

By note type

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 Supported featuresLimitations
Text - -
    -
  • Table of contents.
  • -
  • Syntax highlight of code blocks, provided a language is selected (does - not work if “Auto-detected” is enabled).
  • -
  • Rendering for math equations.
  • -
-
-
    -
  • Including notes is not supported.
  • -
  • Inline Mermaid diagrams are not rendered.
  • -
-
Code - -
    -
  • Basic support (displaying the contents of the note in a monospace font).
  • -
-
-
    -
  • No syntax highlight.
  • -
-
Saved Search - Not supported. 
Relation Map - Not supported. 
Note Map - Not supported. 
Render Note - Not supported. 
Collections - -
    -
  • The child notes are displayed in a fixed format. 
  • -
-
-
    -
  • More advanced view types such as the calendar view are not supported.
  • -
-
Mermaid Diagrams - -
    -
  • The diagram is displayed as a vector image.
  • -
-
-
    -
  • No further interaction supported.
  • -
-
Canvas - -
    -
  • The diagram is displayed as a vector image.
  • -
-
-
    -
  • No further interaction supported.
  • -
-
Web View - Not supported. 
Mind Map - The diagram is displayed as a vector image. -
    -
  • No further interaction supported.
  • -
-
Geo Map View - Not supported. 
File - Basic interaction (downloading the file). -
    -
  • No further interaction supported.
  • -
-
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
 Supported featuresLimitations
Text + +
    +
  • Table of contents.
  • +
  • Syntax highlight of code blocks, provided a language is selected (does + not work if “Auto-detected” is enabled).
  • +
  • Rendering for math equations.
  • +
+
+
    +
  • Including notes is not supported.
  • +
  • Inline Mermaid diagrams are not rendered.
  • +
+
Code + +
    +
  • Basic support (displaying the contents of the note in a monospace font).
  • +
+
+
    +
  • No syntax highlight.
  • +
+
Saved Search + Not supported. 
Relation Map + Not supported. 
Note Map + Not supported. 
Render Note + Not supported. 
Collections + +
    +
  • The child notes are displayed in a fixed format. 
  • +
+
+
    +
  • More advanced view types such as the calendar view are not supported.
  • +
+
Mermaid Diagrams + +
    +
  • The diagram is displayed as a vector image.
  • +
+
+
    +
  • No further interaction supported.
  • +
+
Canvas + +
    +
  • The diagram is displayed as a vector image.
  • +
+
+
    +
  • No further interaction supported.
  • +
+
Web View + Not supported. 
Mind Map + The diagram is displayed as a vector image. +
    +
  • No further interaction supported.
  • +
+
Geo Map View + Not supported. 
File + Basic interaction (downloading the file). +
    +
  • No further interaction supported.
  • +
+
+

While the sharing feature is powerful, it has some limitations:

Some of these limitations may be addressed in future updates.

Prerequisites

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. +
  2. 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.

    @@ -188,41 +193,41 @@ class="image"> Share Note

  3. -
  4. -

    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).

    -
  5. +
  6. 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.

-

Security Considerations

+ Subtree" in the Global menu. + This allows you to manage and navigate through all the notes you have made + public.

+

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.

-

Advanced Sharing Options

-

Customizing the Appearance of Shared Notes

+

Advanced sharing options

+

Customizing the appearance of shared notes

The default design should be a good starting point, but you can customize it using your own CSS:

+

Exiting out of the code block

+ +

Syntax highlighting & color schemes

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.

Keyboard interaction

@@ -20,7 +20,7 @@ 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 +
  • To-do list: Start a line with - [ ] for an unchecked item or [x] for a checked item.
  • @@ -29,7 +29,7 @@
  • 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.
  • @@ -56,7 +56,7 @@ 2 - + Press Enter to create a new list item. @@ -71,7 +71,7 @@ 4 + src="10_Lists_image.png" width="676" height="112"> At this point, insert any desired block-level item such as a code block. @@ -79,7 +79,7 @@ 5 + src="8_Lists_image.png" width="675" height="129"> To continue with a new bullet point, press Enter until the cursor moves to a new blank position. @@ -95,4 +95,11 @@

    The same principle applies to all three list types (bullet, numbered and - to-do).

    \ No newline at end of file + to-do).

    +

    To-do lists

    + \ No newline at end of file diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Lists_image.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Lists_image.png index 30a9511b0..1282f27ec 100644 Binary files a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Lists_image.png and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Lists_image.png differ diff --git a/docs/Developer Guide/!!!meta.json b/docs/Developer Guide/!!!meta.json index 1dfe72240..997d24d43 100644 --- a/docs/Developer Guide/!!!meta.json +++ b/docs/Developer Guide/!!!meta.json @@ -1,6 +1,6 @@ { "formatVersion": 2, - "appVersion": "0.98.1", + "appVersion": "0.99.0", "files": [ { "isClone": false, diff --git a/docs/Release Notes/!!!meta.json b/docs/Release Notes/!!!meta.json index a4b3eb403..e9ad02d7a 100644 --- a/docs/Release Notes/!!!meta.json +++ b/docs/Release Notes/!!!meta.json @@ -1,6 +1,6 @@ { "formatVersion": 2, - "appVersion": "0.98.1", + "appVersion": "0.99.0", "files": [ { "isClone": false, diff --git a/docs/User Guide/!!!meta.json b/docs/User Guide/!!!meta.json index e1fdaa441..4c30efe46 100644 --- a/docs/User Guide/!!!meta.json +++ b/docs/User Guide/!!!meta.json @@ -1,6 +1,6 @@ { "formatVersion": 2, - "appVersion": "0.98.1", + "appVersion": "0.99.0", "files": [ { "isClone": false, @@ -6713,23 +6713,23 @@ "dataFileName": "Lists.md", "attachments": [ { - "attachmentId": "5cmICTYfg13g", + "attachmentId": "1d3z8mz0JANE", "title": "image.png", "role": "image", - "mime": "image/jpg", + "mime": "image/png", "position": 10, "dataFileName": "Lists_image.png" }, { - "attachmentId": "6jl7tboJfutt", + "attachmentId": "7YtO7boIQcSu", "title": "image.png", "role": "image", - "mime": "image/jpg", + "mime": "image/png", "position": 10, "dataFileName": "1_Lists_image.png" }, { - "attachmentId": "7Ledf67P1S1b", + "attachmentId": "eCftcYsVKdAI", "title": "image.png", "role": "image", "mime": "image/png", @@ -6737,7 +6737,7 @@ "dataFileName": "2_Lists_image.png" }, { - "attachmentId": "d4XfLoK5srYZ", + "attachmentId": "fB3ZhdfysYC3", "title": "image.png", "role": "image", "mime": "image/jpg", @@ -6745,15 +6745,15 @@ "dataFileName": "3_Lists_image.png" }, { - "attachmentId": "eL11eZMPwpmH", + "attachmentId": "IZewdPx4evIx", "title": "image.png", "role": "image", - "mime": "image/jpg", + "mime": "image/png", "position": 10, "dataFileName": "4_Lists_image.png" }, { - "attachmentId": "EnkTpdeLJ6Ft", + "attachmentId": "JopMc0iA0dqA", "title": "image.png", "role": "image", "mime": "image/jpg", @@ -6761,7 +6761,7 @@ "dataFileName": "5_Lists_image.png" }, { - "attachmentId": "If3k6Tt5cPBt", + "attachmentId": "kZMYrJubac6T", "title": "image.png", "role": "image", "mime": "image/jpg", @@ -6769,7 +6769,7 @@ "dataFileName": "6_Lists_image.png" }, { - "attachmentId": "MxgVFEyXwRxo", + "attachmentId": "PGeVq8YAQBFA", "title": "image.png", "role": "image", "mime": "image/png", @@ -6777,26 +6777,26 @@ "dataFileName": "7_Lists_image.png" }, { - "attachmentId": "Te4LNZWv4ovM", + "attachmentId": "VgoG6BtlLYn7", "title": "image.png", "role": "image", - "mime": "image/png", + "mime": "image/jpg", "position": 10, "dataFileName": "8_Lists_image.png" }, { - "attachmentId": "tqeIwudL5QEY", + "attachmentId": "y0zFP6x0IRRf", "title": "image.png", "role": "image", - "mime": "image/png", + "mime": "image/jpg", "position": 10, "dataFileName": "9_Lists_image.png" }, { - "attachmentId": "zZGT8pbt2myS", + "attachmentId": "z8eVlXe2WKqr", "title": "image.png", "role": "image", - "mime": "image/png", + "mime": "image/jpg", "position": 10, "dataFileName": "10_Lists_image.png" } @@ -10451,24 +10451,31 @@ { "type": "relation", "name": "internalLink", - "value": "bwZpz2ajCEwO", + "value": "x3i7MxGccDuM", "isInheritable": false, "position": 150 }, { "type": "relation", "name": "internalLink", - "value": "Wy267RK4M69c", + "value": "bwZpz2ajCEwO", "isInheritable": false, "position": 160 }, { "type": "relation", "name": "internalLink", - "value": "Qjt68inQ2bRj", + "value": "Wy267RK4M69c", "isInheritable": false, "position": 170 }, + { + "type": "relation", + "name": "internalLink", + "value": "Qjt68inQ2bRj", + "isInheritable": false, + "position": 180 + }, { "type": "label", "name": "shareAlias", @@ -10487,14 +10494,6 @@ "format": "markdown", "dataFileName": "Sharing.md", "attachments": [ - { - "attachmentId": "2kLFcH6hel9i", - "title": "shared-list.png", - "role": "image", - "mime": "image/png", - "position": 10, - "dataFileName": "Sharing_shared-list.png" - }, { "attachmentId": "ibqWQUOCMhIE", "title": "image.png", @@ -11385,6 +11384,13 @@ "type": "text", "mime": "text/markdown", "attributes": [ + { + "type": "relation", + "name": "internalLink", + "value": "tAassRL4RSQL", + "isInheritable": false, + "position": 10 + }, { "type": "label", "name": "shareAlias", diff --git a/docs/User Guide/User Guide/Advanced Usage/Configuration (config.ini or e.md b/docs/User Guide/User Guide/Advanced Usage/Configuration (config.ini or e.md index de6abf21e..e89d1a3fb 100644 --- a/docs/User Guide/User Guide/Advanced Usage/Configuration (config.ini or e.md +++ b/docs/User Guide/User Guide/Advanced Usage/Configuration (config.ini or e.md @@ -1,6 +1,10 @@ # Configuration (config.ini or environment variables) Trilium supports configuration via a file named `config.ini` and environment variables. This document provides a comprehensive reference for all configuration options. +## Location of the configuration file + +The configuration file is not located in the same directory as the application. Instead, the `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 Configuration values are loaded in the following order of precedence (highest to lowest): diff --git a/docs/User Guide/User Guide/Advanced Usage/Sharing.md b/docs/User Guide/User Guide/Advanced Usage/Sharing.md index 64b5767dd..37ce5fee8 100644 --- a/docs/User Guide/User Guide/Advanced Usage/Sharing.md +++ b/docs/User Guide/User Guide/Advanced Usage/Sharing.md @@ -16,7 +16,7 @@ Trilium allows you to share selected notes as **publicly accessible** read-only ### By note type -
     Supported featuresLimitations
    Text
    • Table of contents.
    • Syntax highlight of code blocks, provided a language is selected (does not work if “Auto-detected” is enabled).
    • Rendering for math equations.
    • Including notes is not supported.
    • Inline Mermaid diagrams are not rendered.
    Code
    • Basic support (displaying the contents of the note in a monospace font).
    • No syntax highlight.
    Saved SearchNot supported. 
    Relation MapNot supported. 
    Note MapNot supported. 
    Render NoteNot supported. 
    Collections
    • The child notes are displayed in a fixed format. 
    • More advanced view types such as the calendar view are not supported.
    Mermaid Diagrams
    • The diagram is displayed as a vector image.
    • No further interaction supported.
    Canvas
    • The diagram is displayed as a vector image.
    • No further interaction supported.
    Web ViewNot supported. 
    Mind MapThe diagram is displayed as a vector image.
    • No further interaction supported.
    Geo Map ViewNot supported. 
    FileBasic interaction (downloading the file).
    • No further interaction supported.
    +
     Supported featuresLimitations
    Text
    • Table of contents.
    • Syntax highlight of code blocks, provided a language is selected (does not work if “Auto-detected” is enabled).
    • Rendering for math equations.
    • Including notes is not supported.
    • Inline Mermaid diagrams are not rendered.
    Code
    • Basic support (displaying the contents of the note in a monospace font).
    • No syntax highlight.
    Saved SearchNot supported. 
    Relation MapNot supported. 
    Note MapNot supported. 
    Render NoteNot supported. 
    Collections
    • The child notes are displayed in a fixed format. 
    • More advanced view types such as the calendar view are not supported.
    Mermaid Diagrams
    • The diagram is displayed as a vector image.
    • No further interaction supported.
    Canvas
    • The diagram is displayed as a vector image.
    • No further interaction supported.
    Web ViewNot supported. 
    Mind MapThe diagram is displayed as a vector image.
    • No further interaction supported.
    Geo Map ViewNot supported. 
    FileBasic interaction (downloading the file).
    • No further interaction supported.
    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. ![Share Note](Sharing_share-single-note.png) 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. - -![Shared Notes List](Sharing_shared-list.png) - -### 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 -
    AttributeDescription
    shareHiddenFromTreethis note is hidden from left navigation tree, but still accessible with its URL
    shareExternalLinknote will act as a link to an external website in the share tree
    shareAliasdefine an alias using which the note will be available under https://your_trilium_host/share/[your_alias]
    shareOmitDefaultCssdefault share page CSS will be omitted. Use when you make extensive styling changes.
    shareRootmarks note which is served on /share root.
    shareDescriptiondefine text to be added to the HTML meta tag for description
    shareRawNote 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.
    shareCredentialsrequire 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.
    shareIndexNote with this label will list all roots of shared notes.
    +
    AttributeDescription
    shareHiddenFromTreethis note is hidden from left navigation tree, but still accessible with its URL
    shareExternalLinknote will act as a link to an external website in the share tree
    shareAliasdefine an alias using which the note will be available under https://your_trilium_host/share/[your_alias]
    shareOmitDefaultCssdefault share page CSS will be omitted. Use when you make extensive styling changes.
    shareRootmarks note which is served on /share root.
    shareDescriptiondefine text to be added to the HTML meta tag for description
    shareRawNote 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.
    shareCredentialsrequire 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.
    shareIndexNote 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 8002303f8..000000000 Binary files a/docs/User Guide/User Guide/Advanced Usage/Sharing_shared-list.png and /dev/null differ diff --git a/docs/User Guide/User Guide/Note Types/Text/10_Lists_image.png b/docs/User Guide/User Guide/Note Types/Text/10_Lists_image.png index 1282f27ec..fba0cc85c 100644 Binary files a/docs/User Guide/User Guide/Note Types/Text/10_Lists_image.png and b/docs/User Guide/User Guide/Note Types/Text/10_Lists_image.png differ diff --git a/docs/User Guide/User Guide/Note Types/Text/1_Lists_image.png b/docs/User Guide/User Guide/Note Types/Text/1_Lists_image.png index fba0cc85c..4a17f481c 100644 Binary files a/docs/User Guide/User Guide/Note Types/Text/1_Lists_image.png and b/docs/User Guide/User Guide/Note Types/Text/1_Lists_image.png differ diff --git a/docs/User Guide/User Guide/Note Types/Text/2_Lists_image.png b/docs/User Guide/User Guide/Note Types/Text/2_Lists_image.png index ee7a6bdea..2473cd310 100644 Binary files a/docs/User Guide/User Guide/Note Types/Text/2_Lists_image.png and b/docs/User Guide/User Guide/Note Types/Text/2_Lists_image.png differ diff --git a/docs/User Guide/User Guide/Note Types/Text/4_Lists_image.png b/docs/User Guide/User Guide/Note Types/Text/4_Lists_image.png index 8369a03c6..3caf2d880 100644 Binary files a/docs/User Guide/User Guide/Note Types/Text/4_Lists_image.png and b/docs/User Guide/User Guide/Note Types/Text/4_Lists_image.png differ diff --git a/docs/User Guide/User Guide/Note Types/Text/7_Lists_image.png b/docs/User Guide/User Guide/Note Types/Text/7_Lists_image.png index 3caf2d880..ee7a6bdea 100644 Binary files a/docs/User Guide/User Guide/Note Types/Text/7_Lists_image.png and b/docs/User Guide/User Guide/Note Types/Text/7_Lists_image.png differ diff --git a/docs/User Guide/User Guide/Note Types/Text/8_Lists_image.png b/docs/User Guide/User Guide/Note Types/Text/8_Lists_image.png index 4a17f481c..30a9511b0 100644 Binary files a/docs/User Guide/User Guide/Note Types/Text/8_Lists_image.png and b/docs/User Guide/User Guide/Note Types/Text/8_Lists_image.png differ diff --git a/docs/User Guide/User Guide/Note Types/Text/9_Lists_image.png b/docs/User Guide/User Guide/Note Types/Text/9_Lists_image.png index 2473cd310..8369a03c6 100644 Binary files a/docs/User Guide/User Guide/Note Types/Text/9_Lists_image.png and b/docs/User Guide/User Guide/Note Types/Text/9_Lists_image.png differ diff --git a/docs/User Guide/User Guide/Note Types/Text/Developer-specific formatting/Code blocks.md b/docs/User Guide/User Guide/Note Types/Text/Developer-specific formatting/Code blocks.md index 18960b335..31ae3233e 100644 --- a/docs/User Guide/User Guide/Note Types/Text/Developer-specific formatting/Code blocks.md +++ b/docs/User Guide/User Guide/Note Types/Text/Developer-specific formatting/Code blocks.md @@ -13,6 +13,14 @@ Note that this feature is meant for generally small snippets of code. For larger * Type ` ``` ` (as in Markdown). * Note that it's not possible to specify the language, as it will default to the last selected language. +## Exiting out of the code block + +* To exit out of a code block and enter a normal paragraph, move the cursor at the end of the code block and press Enter twice. +* Similarly, to insert a paragraph above the note block, move the cursor at the beginning of the code block and press Enter twice. + +> [!NOTE] +> If you've pasted a code block with a more complex HTML structure, exiting out of the code block by pressing Enter multiple times might not work. In that case the best approach is to delete the code block entirely and use Ctrl+Shift+V (paste as plain text). + ## Syntax highlighting & color schemes Since TriliumNext v0.90.12, Trilium will try to offer syntax highlighting to the code block. Note that the syntax highlighting mechanism is slightly different than the one in Code notes as different technologies are involved. diff --git a/docs/User Guide/User Guide/Note Types/Text/Lists.md b/docs/User Guide/User Guide/Note Types/Text/Lists.md index efa0c5a62..8dcabdc25 100644 --- a/docs/User Guide/User Guide/Note Types/Text/Lists.md +++ b/docs/User Guide/User Guide/Note Types/Text/Lists.md @@ -1,23 +1,23 @@ # Lists There are three types of lists supported by text 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 | ![](6_Lists_image.png) | First, create a list. | -| 2 | ![](4_Lists_image.png) | Press Enter to create a new list item. | +| 2 | ![](9_Lists_image.png) | Press Enter to create a new list item. | | 3 | ![](5_Lists_image.png) | 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 30a9511b0..1282f27ec 100644 Binary files a/docs/User Guide/User Guide/Note Types/Text/Lists_image.png and b/docs/User Guide/User Guide/Note Types/Text/Lists_image.png differ