diff --git a/apps/client/src/print.css b/apps/client/src/print.css index d0123c810e..b08ae29c36 100644 --- a/apps/client/src/print.css +++ b/apps/client/src/print.css @@ -1,8 +1,8 @@ @import "boxicons/css/boxicons.min.css"; :root { + --print-font-family: sans-serif; --print-font-size: 11pt; - --ck-content-color-image-caption-background: transparent !important; } @page { @@ -14,6 +14,7 @@ body { width: 100%; height: 100%; color: black; + font-family: var(--print-font-family); } .note-list-widget.full-height, @@ -26,6 +27,12 @@ body { } body[data-note-type="text"] .ck-content { + --ck-content-font-family: var(--print-font-family); + --ck-content-font-size: var(--print-font-size); + --ck-content-font-color: black; + --ck-content-line-height: 1.5; + --ck-content-color-image-caption-background: transparent; + font-size: var(--print-font-size); text-align: justify; } @@ -154,4 +161,4 @@ span[style] { .page-break::after { display: none !important; } -/* #endregion */ \ No newline at end of file +/* #endregion */ diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/Notes/Printing & Exporting as PDF.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/Notes/Printing & Exporting as PDF.html index 3083d72a84..cae0118ea7 100644 --- a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/Notes/Printing & Exporting as PDF.html +++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/Notes/Printing & Exporting as PDF.html @@ -61,7 +61,8 @@ class="admonition note">

For example, to change the font of the document from the one defined by - the theme or the user to a serif one:

body {
-	--main-font-family: serif !important;
-    --detail-font-family: var(--main-font-family) !important;
+    the theme or the user to a serif one:

:root {
+	--print-font-family: serif;
+    --print-font-size: 11pt;
 }

To remark:

  • Multiple CSS notes can be add by using multiple ~printCss relations.
  • -
  • If the note pointing to the printCss doesn't +
  • If the note pointing to the printCss doesn't have the right note type or mime type, it will be ignored.
  • -
  • If migrating from a previous version where Custom app-wide CSS, there's no need for - @media print { since the style-sheet is used only for printing.
  • +
  • If migrating from a previous version where Custom app-wide CSS, there's no need for + @media print { since the style-sheet is used only for printing.

Under the hood

Both printing and exporting as PDF use the same mechanism: a note is rendered diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/UI Elements/Note types with split view.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/UI Elements/Note types with split view.html index 0f3b39ee11..605062dcaa 100644 --- a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/UI Elements/Note types with split view.html +++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/UI Elements/Note types with split view.html @@ -1,8 +1,8 @@ -

Split view is a feature of Mermaid Diagrams and  +

Split view is a feature of Mermaid Diagrams and  Markdown notes which displays both the source code on one side + class="reference-link" href="#root/_help_6RM1Q7ppFVoj">Markdown notes which displays both the source code on one side and the preview of the content on the other.

-

Mermaid Diagrams also +

Mermaid Diagrams also allow changing between a horizontal or a vertical split, to accommodate for the various sizes of diagrams.

Display modes and interaction

@@ -20,12 +20,12 @@
  • Preview which displays only the rendering of the diagram or text in full screen, especially useful for read-only notes.
  • -

    These buttons can be found near the Note buttons section - on the New Layout, - or in the Floating buttons on +

    These buttons can be found near the Note buttons section + on the New Layout, + or in the Floating buttons on the old layout.

    The display node is stored at note level.

    Relation to read-only notes

    -

    If a note is marked as read-only, - the source view will not be editable. While in preview mode, marking a - note as read-only has no effect since the preview itself is not editable.

    \ No newline at end of file +

    If a note is marked as read-only, the + source view will not be editable. While in preview mode, marking a note + as read-only has no effect since the preview itself is not editable.

    \ No newline at end of file diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Installation & Setup/Data directory.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Installation & Setup/Data directory.html index fbd042717a..ecd52a4302 100644 --- a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Installation & Setup/Data directory.html +++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Installation & Setup/Data directory.html @@ -70,6 +70,21 @@ this:

    TRILIUM_DATA_DIR=/home/myuser/data/my-trilium-data trilium

    You can then save the above command as a shell script on your path for convenience.

    +

    Electron user data directory (desktop only)

    +

    When running the desktop application, Electron stores internal data (caches, + spell-check dictionaries, session storage, etc.) separately from the Trilium + data directory. By default this goes to the system's application data folder + (e.g. %APPDATA% on Windows), which may be + undesirable in corporate environments with roaming profiles or when running + in portable mode.

    +

    When TRILIUM_DATA_DIR is set (e.g. via the + trilium-portablescript), the Electron user data is automatically + redirected into ${TRILIUM_DATA_DIR}/electron-user-data/, + so no files are written to the system's roaming profile.

    +

    If you need to store the Electron data in a different location than the + Trilium data directory, you can set the TRILIUM_ELECTRON_DATA_DIR environment + variable to an explicit path.

    Fine-grained directory/path location

    Apart from the data directory, some of the subdirectories of it can be moved elsewhere by changing an environment variable:

    @@ -129,5 +144,13 @@ Path to Configuration (config.ini or environment variables) file. + + TRILIUM_ELECTRON_DATA_DIR + + ${TRILIUM_DATA_DIR}/electron-user-data (portable) + or system appData (default) + Directory where Electron stores internal data such as caches and spell-check + dictionaries (desktop only). + \ No newline at end of file diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Installation & Setup/Desktop Installation.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Installation & Setup/Desktop Installation.html index 40d7ddd89c..e1ea2fc9b7 100644 --- a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Installation & Setup/Desktop Installation.html +++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Installation & Setup/Desktop Installation.html @@ -23,7 +23,9 @@
  • trilium-portable: Launches Trilium in portable mode, where the data directory is created within the application's directory, making it easy to move the - entire setup.
  • + entire setup. Electron's internal data (caches, dictionaries, etc.) is + also stored within the data directory, so no files are written to the system's + roaming profile.
  • trilium-safe-mode: Boots Trilium in "safe mode," disabling any startup scripts that might cause the application to crash.
  • diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types.html index 2607200081..d468c589c9 100644 --- a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types.html +++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types.html @@ -9,8 +9,7 @@ note where to place the new one and select:

    • Insert note after, to put the new note underneath the one selected.
    • -
    • Insert child note, to insert the note as a child of the selected +
    • Insert child note, to insert the note as a child of the selected note.

    @@ -21,8 +20,7 @@

  • When adding a link in a Text note, type the desired title of the new note and press Enter. Afterwards the type of the note will be asked.
  • -
  • Similarly, when creating a new tab, type the desired title and press Enter.
  • +
  • Similarly, when creating a new tab, type the desired title and press Enter.
  • Changing the type of a note

    It is possible to change the type of a note after it has been created @@ -32,96 +30,94 @@ edit the source of a note.

    Supported note types

    The following note types are supported by Trilium:

    -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Note TypeDescription
    Text - The default note type, which allows for rich text formatting, images, - admonitions and right-to-left support.
    Code - Uses a mono-space font and can be used to store larger chunks of code - or plain text than a text note, and has better syntax highlighting.
    Saved Search - Stores the information about a search (the search text, criteria, etc.) - for later use. Can be used for quick filtering of a large amount of notes, - for example. The search can easily be triggered.
    Relation Map - Allows easy creation of notes and relations between them. Can be used - for mainly relational data such as a family tree.
    Note Map - Displays the relationships between the notes, whether via relations or - their hierarchical structure.
    Render Note - Used in Scripting, - it displays the HTML content of another note. This allows displaying any - kind of content, provided there is a script behind it to generate it.
    Collections - Displays the children of the note either as a grid, a list, or for a more - specialized case: a calendar.   -
    -
    Generally useful for easy reading of short notes.
    Mermaid Diagrams - Displays diagrams such as bar charts, flow charts, state diagrams, etc. - Requires a bit of technical knowledge since the diagrams are written in - a specialized format.
    Canvas - Allows easy drawing of sketches, diagrams, handwritten content. Uses the - same technology behind excalidraw.com.
    Web View - Displays the content of an external web page, similar to a browser.
    Mind Map - Easy for brainstorming ideas, by placing them in a hierarchical layout.
    Geo Map - Displays the children of the note as a geographical map, one use-case - would be to plan vacations. It even has basic support for tracks. Notes - can also be created from it.
    File - Represents an uploaded file such as PDFs, images, video or audio files.
    -
    \ No newline at end of file + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Note TypeDescription
    Text + The default note type, which allows for rich text formatting, images, + admonitions and right-to-left support.
    Code + Uses a mono-space font and can be used to store larger chunks of code + or plain text than a text note, and has better syntax highlighting.
    Saved Search + Stores the information about a search (the search text, criteria, etc.) + for later use. Can be used for quick filtering of a large amount of notes, + for example. The search can easily be triggered.
    Relation Map + Allows easy creation of notes and relations between them. Can be used + for mainly relational data such as a family tree.
    Note Map + Displays the relationships between the notes, whether via relations or + their hierarchical structure.
    Render Note + Used in Scripting, + it displays the HTML content of another note. This allows displaying any + kind of content, provided there is a script behind it to generate it.
    Collections + Displays the children of the note either as a grid, a list, or for a more + specialized case: a calendar.   +
    +
    Generally useful for easy reading of short notes.
    Mermaid Diagrams + Displays diagrams such as bar charts, flow charts, state diagrams, etc. + Requires a bit of technical knowledge since the diagrams are written in + a specialized format.
    Canvas + Allows easy drawing of sketches, diagrams, handwritten content. Uses the + same technology behind excalidraw.com.
    Web View + Displays the content of an external web page, similar to a browser.
    Mind Map + Easy for brainstorming ideas, by placing them in a hierarchical layout.
    Geo Map + Displays the children of the note as a geographical map, one use-case + would be to plan vacations. It even has basic support for tracks. Notes + can also be created from it.
    File + Represents an uploaded file such as PDFs, images, video or audio files.
    \ No newline at end of file diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/File.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/File.html index 152140d5ed..f64ba7eade 100644 --- a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/File.html +++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/File.html @@ -5,8 +5,7 @@ create a File note type directly:

    • Drag a file into the Note Tree.
    • -
    • Right click a note and select Import into note and point it to +
    • Right click a note and select Import into note and point it to one of the supported files.

    Supported file types

    @@ -83,30 +82,28 @@ href="#root/_help_BlN9DFI679QC">Ribbon.
    • Download, which will download the file for local use.
    • -
    • Open, will will open the file with the system-default application.
    • -
    • Upload new revision to replace the file with a new one.
    • +
    • Open, will will open the file with the system-default application.
    • +
    • Upload new revision to replace the file with a new one.
    - -
  • It is not possible to change the note type of a File note.
  • -
  • Convert into an attachment from the note menu.
  • + +
  • It is not possible to change the note type of a File note.
  • +
  • Convert into an attachment from the note menu.
  • Relation with other notes

    • Files are also displayed in the Note List based on their type:

      -

      - -

      + +
    • +
    • +

      Non-image files can be embedded into text notes as read-only widgets via + the Include Note functionality.

      +
    • +
    • +

      Image files can be embedded into text notes like normal images via  + Image references.

    • -
    • Non-image files can be embedded into text notes as read-only widgets via - the Include Note functionality.
    • -
    • Image files can be embedded into text notes like normal images via  - Image references.
    \ No newline at end of file diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Markdown.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Markdown.html index 74cf113776..2d3d41e7f9 100644 --- a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Markdown.html +++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Markdown.html @@ -1,13 +1,12 @@ -

    Trilium has always supported Markdown through its import feature, +

    Trilium has always supported Markdown through its import feature, however the file was either transformed to a Text note - (converted to Trilium's internal HTML format) or saved as a Code note + href="#root/_help_iPIMuisry3hd">Text note (converted to Trilium's internal + HTML format) or saved as a Code note with only syntax highlight.

    This note type is a split view, meaning that both the source code and a preview of the document are displayed side-by-side. See Note types with split view for - more information.

    + href="#root/_help_SL5f1Auq7sVN">Note types with split view for more + information.

    Rationale

    The goal of this note type is to fill a gap: rendering Markdown but not altering its structure or its whitespace which would inevitably change @@ -33,65 +32,53 @@

    The following features are supported by Trilium's Markdown format and will show up in the preview pane:

      -
    • All standard and GitHub-flavored syntax (basic formatting, tables, blockquotes)
    • -
    • Code blocks with syntax highlight (e.g. ```js) - and automatic syntax highlight
    • -
    • Block quotes & admonitions -
    • -
    • Math Equations -
    • -
    • Mermaid Diagrams using - ```mermaid -
    • -
    • -

      Include Note (no - builtin Markdown syntax, but HTML syntax works just fine):

      <section class="include-note" data-note-id="vJDjQm0VK8Na" data-box-size="expandable">
      -	&nbsp;
      +  
    • +

      All standard and GitHub-flavored syntax (basic formatting, tables, blockquotes)

      +
    • +
    • +

      Code blocks with syntax highlight (e.g. <!--CODE_BLOCK_1776493385878_0-->mermaid +

      +
    • +
    • +

      Include Note (no + builtin Markdown syntax, but HTML syntax works just fine):

      <section class="include-note" data-note-id="vJDjQm0VK8Na" data-box-size="expandable">
      +    &nbsp;
       </section>n
      -
    • -
    • -

      Internal (reference) links via - its HTML syntax, or through a Wikilinks-like format (only  - Note ID):

      [[Hg8TS5ZOxti6]]
      -
    • +
    • +
    • +

      Internal (reference) links via + its HTML syntax, or through a Wikilinks-like format (only  + Note ID):

      [[Hg8TS5ZOxti6]]
      +

    Creating Markdown notes

    There are two ways to create a Markdown note:

      -
    1. Create a new note (e.g. in the Note Tree) +
    2. Create a new note (e.g. in the Note Tree) and select the type Markdown, just like all the other note types.
    3. -
    4. Create a note of type Code and - select as the language either Markdown or GitHub-Flavored Markdown. +
    5. Create a note of type Code and + select as the language either Markdown or GitHub-Flavored Markdown. This maintains compatibility with your existing notes prior to the introduction of this feature.

    Import/export

    • By default, when importing a single Markdown file it automatically gets - converted to a Text note. + converted to a Text note. To avoid that and have it imported as a Markdown note instead:

        -
      • -

        Right click the Note Tree and - select Import into note.

        -
      • -
      • -

        Select the file normally.

        -
      • -
      • -

        Uncheck Import HTML, Markdown and TXT as text notes if it's unclear from the metadata.

        -
      • +
      • Right click the Note Tree and + select Import into note.
      • +
      • Select the file normally.
      • +
      • Uncheck Import HTML, Markdown and TXT as text notes if it's unclear from the metadata.
    • @@ -105,9 +92,8 @@

    Conversion between text notes and Markdown notes

    Currently there is no built-in functionality to convert a Text note - into a Markdown note or vice-versa. We do have plans to address this in - the future.

    + href="#root/_help_iPIMuisry3hd">Text note into a Markdown note or vice-versa. + We do have plans to address this in the future.

    This can be achieved manually, for a single note:

    1. Export the file as Markdown, with single format.
    2. @@ -135,6 +121,6 @@

      This feature of synchronizing the scroll is based on blocks but it's provided on a best-effort basis since our underlying Markdown library doesn't support this feature natively, so we had to implement our own algorithm. Feel free - to report issues, - but always provide a sample Markdown file to be able to reproduce it.

      + to report issues, but always provide a + sample Markdown file to be able to reproduce it.

      \ No newline at end of file diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Mermaid Diagrams.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Mermaid Diagrams.html index d6ff44cd93..a17a7ea0a8 100644 --- a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Mermaid Diagrams.html +++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Mermaid Diagrams.html @@ -12,8 +12,8 @@ the diagram.

      This note type is a split view, meaning that both the source code and a preview of the document are displayed side-by-side. See Note types with split view for - more information.

      + href="#root/_help_SL5f1Auq7sVN">Note types with split view for more + information.

      Sample diagrams

      Starting with v0.103.0, Mermaid diagrams no longer start with a sample flowchart, but instead a pane at the bottom will show all the supported @@ -52,34 +52,30 @@

    3. The preview can be moved around by holding the left mouse button and dragging.
    4. -
    5. Zooming can also be done by using the scroll wheel.
    6. -
    7. The zoom and position on the preview will remain fixed as the diagram - changes, to be able to work more easily with large diagrams.
    8. - +
    9. Zooming can also be done by using the scroll wheel.
    10. +
    11. The zoom and position on the preview will remain fixed as the diagram + changes, to be able to work more easily with large diagrams.
    12. +
    13. The size of the source/preview panes can be adjusted by hovering over the border between them and dragging it with the mouse.
    14. In the Floating buttons area:
      • The source/preview can be laid out left-right or bottom-top via the Move editing pane to the left / bottom option.
      • -
      • Press Lock editing to automatically mark the note as read-only. +
      • Press Lock editing to automatically mark the note as read-only. In this mode, the code pane is hidden and the diagram is displayed full-size. Similarly, press Unlock editing to mark a read-only note as editable.
      • -
      • Press the Copy image reference to the clipboard to be able to insert - the image representation of the diagram into a text note. See Image references for more information.
      • -
      • Press the Export diagram as SVG to download a scalable/vector rendering - of the diagram. Can be used to present the diagram without degrading when - zooming.
      • +
      • Press the Copy image reference to the clipboard to be able to insert + the image representation of the diagram into a text note. See Image references for more information.
      • +
      • Press the Export diagram as SVG to download a scalable/vector rendering + of the diagram. Can be used to present the diagram without degrading when + zooming.
      • Press the Export diagram as PNG to download a normal image (at 1x scale, raster) of the diagram. Can be used to send the diagram in more traditional channels such as e-mail.
      • -
      -
    15. + +

      Errors in the diagram

      If there is an error in the source code, the error will be displayed in diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Render Note.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Render Note.html index 4a33c30bfe..efff5c09b9 100644 --- a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Render Note.html +++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Render Note.html @@ -13,13 +13,11 @@

      1. HTML language for the legacy/vanilla method, with what needs to be displayed (for example <p>Hello world.</p>).
      2. -
      3. JSX for the Preact-based approach (see below).
      4. -
      +
    16. JSX for the Preact-based approach (see below).
    17. +
  • Create a Render Note.
  • -
  • Assign the renderNote relation to +
  • Assign the renderNote relation to point at the previously created code note.
  • Legacy scripting using jQuery

    @@ -48,9 +46,10 @@ $dateEl.text(new Date());
    need to provide a HTML anymore.

    Here are the steps to creating a simple render note:

      -
    1. Create a note of type Render Note.
    2. -
    3. +
    4. +

      Create a note of type Render Note.

      +
    5. +
    6. Create a child Code note with JSX as the language.
      As an example, use the following content:

      export default function() {
      @@ -60,17 +59,20 @@ $dateEl.text(new Date());
      </> ); }
      -
    7. -
    8. In the parent render note, define a ~renderNote relation - pointing to the newly created child.
    9. -
    10. Refresh the render note and it should display a “Hello world” message.
    11. + +
    12. +

      In the parent render note, define a ~renderNote relation + pointing to the newly created child.

      +
    13. +
    14. +

      Refresh the render note and it should display a “Hello world” message.

      +

    Refreshing the note

    It's possible to refresh the note via:

    Examples

    diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Spreadsheets.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Spreadsheets.html index 06f944a848..b9ab252d4c 100644 --- a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Spreadsheets.html +++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Spreadsheets.html @@ -64,9 +64,8 @@ yet:

    If you would like us to work on these features, consider supporting us.

    Known limitations

    @@ -81,8 +80,7 @@
  • There is currently no export functionality, as stated previously.
  • -
  • There is no dedicated mobile support. Mobile support is currently experimental +
  • There is no dedicated mobile support. Mobile support is currently experimental in Univer and when it becomes stable, we could potentially integrate it into Trilium as well.
  • \ No newline at end of file diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text.html index 26a0791ace..42dbe0fa44 100644 --- a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text.html +++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text.html @@ -20,171 +20,168 @@

    Fore more information see Formatting toolbar.

    Features and formatting

    Here's a list of various features supported by text notes:

    -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Dedicated articleFeature
    General formatting - -
      -
    • Headings (section titles, paragraph)
    • -
    • Font size
    • -
    • Bold, italic, underline, strike-through
    • -
    • Superscript, subscript
    • -
    • Font color & background color
    • -
    • Remove formatting
    • -
    -
    Lists - -
      -
    • Bulleted lists
    • -
    • Numbered lists
    • -
    • To-do lists
    • -
    -
    Block quotes & admonitions - -
      -
    • Block quotes
    • -
    • Admonitions
    • -
    -
    Tables - -
      -
    • Basic tables
    • -
    • Merging cells
    • -
    • Styling tables and cells.
    • -
    • Table captions
    • -
    -
    Developer-specific formatting - -
      -
    • Inline code
    • -
    • Code blocks
    • -
    • Keyboard shortcuts
    • -
    -
    Footnotes - -
      -
    • Footnotes
    • -
    -
    Images - -
      -
    • Images
    • -
    -
    Links - -
      -
    • External links
    • -
    • Internal Trilium links
    • -
    -
    Include Note - -
      -
    • Include note
    • -
    -
    Insert buttons - -
      -
    • Symbols
    • -
    • Math Equations -
    • -
    • Mermaid diagrams
    • -
    • Horizontal ruler
    • -
    • Page break
    • -
    -
    Other features - - -
    Premium features - - -
    -
    -

    Read-Only vs. Editing Mode

    -

    Text notes are usually opened in edit mode. However, they may open in - read-only mode if the note is too big or the note is explicitly marked - as read-only. For more information, see Read-Only Notes.

    -

    Keyboard shortcuts

    -

    There are numerous keyboard shortcuts to format the text without having - to use the mouse. For a reference of all the key combinations, see  - Keyboard Shortcuts. In addition, see Markdown-like formatting as an alternative - to the keyboard shortcuts.

    -

    Technical details

    -

    For the text editing functionality, Trilium uses a commercial product - (with an open-source base) called CKEditor. - This brings the benefit of having a powerful WYSIWYG (What You See Is What - You Get) editor.

    \ No newline at end of file + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Dedicated articleFeature
    General formatting + +
      +
    • Headings (section titles, paragraph)
    • +
    • Font size
    • +
    • Bold, italic, underline, strike-through
    • +
    • Superscript, subscript
    • +
    • Font color & background color
    • +
    • Remove formatting
    • +
    +
    Lists + +
      +
    • Bulleted lists
    • +
    • Numbered lists
    • +
    • To-do lists
    • +
    +
    Block quotes & admonitions + +
      +
    • Block quotes
    • +
    • Admonitions
    • +
    +
    Tables + +
      +
    • Basic tables
    • +
    • Merging cells
    • +
    • Styling tables and cells.
    • +
    • Table captions
    • +
    +
    Developer-specific formatting + +
      +
    • Inline code
    • +
    • Code blocks
    • +
    • Keyboard shortcuts
    • +
    +
    Footnotes + +
      +
    • Footnotes
    • +
    +
    Images + +
      +
    • Images
    • +
    +
    Links + +
      +
    • External links
    • +
    • Internal Trilium links
    • +
    +
    Include Note + +
      +
    • Include note
    • +
    +
    Insert buttons + +
      +
    • Symbols
    • +
    • Math Equations +
    • +
    • Mermaid diagrams
    • +
    • Horizontal ruler
    • +
    • Page break
    • +
    +
    Other features + + +
    Premium features + + +
    +

    Read-Only vs. Editing Mode

    +

    Text notes are usually opened in edit mode. However, they may open in + read-only mode if the note is too big or the note is explicitly marked + as read-only. For more information, see Read-Only Notes.

    +

    Keyboard shortcuts

    +

    There are numerous keyboard shortcuts to format the text without having + to use the mouse. For a reference of all the key combinations, see  + Keyboard Shortcuts. In addition, see Markdown-like formatting as an alternative + to the keyboard shortcuts.

    +

    Technical details

    +

    For the text editing functionality, Trilium uses a commercial product + (with an open-source base) called CKEditor. + This brings the benefit of having a powerful WYSIWYG (What You See Is What + You Get) editor.

    \ No newline at end of file diff --git a/docs/Developer Guide/Developer Guide/Documentation.md b/docs/Developer Guide/Developer Guide/Documentation.md index aae807a49d..8b2fdc9998 100644 --- a/docs/Developer Guide/Developer Guide/Documentation.md +++ b/docs/Developer Guide/Developer Guide/Documentation.md @@ -1,5 +1,5 @@ # Documentation -There are multiple types of documentation for Trilium: +There are multiple types of documentation for Trilium: * The _User Guide_ represents the user-facing documentation. This documentation can be browsed by users directly from within Trilium, by pressing F1. * The _Developer's Guide_ represents a set of Markdown documents that present the internals of Trilium, for developers. diff --git a/docs/User Guide/!!!meta.json b/docs/User Guide/!!!meta.json index d1b8f5d265..92af202232 100644 --- a/docs/User Guide/!!!meta.json +++ b/docs/User Guide/!!!meta.json @@ -3984,42 +3984,42 @@ "name": "internalLink", "value": "s1aBHPd79XYj", "isInheritable": false, - "position": 30 + "position": 10 }, { "type": "relation", "name": "internalLink", "value": "6RM1Q7ppFVoj", "isInheritable": false, - "position": 40 - }, - { - "type": "relation", - "name": "internalLink", - "value": "CoFPLs3dRlXc", - "isInheritable": false, - "position": 50 + "position": 20 }, { "type": "relation", "name": "internalLink", "value": "8YBEPzcpUgxw", "isInheritable": false, - "position": 60 + "position": 30 }, { "type": "relation", "name": "internalLink", "value": "IjZS7iK5EXtb", "isInheritable": false, - "position": 70 + "position": 40 }, { "type": "relation", "name": "internalLink", "value": "XpOYSgsLkTJy", "isInheritable": false, - "position": 80 + "position": 50 + }, + { + "type": "relation", + "name": "internalLink", + "value": "CoFPLs3dRlXc", + "isInheritable": false, + "position": 60 }, { "type": "label", @@ -10147,17 +10147,24 @@ { "type": "relation", "name": "internalLink", - "value": "XpOYSgsLkTJy", + "value": "SL5f1Auq7sVN", "isInheritable": false, "position": 20 }, { "type": "relation", "name": "internalLink", - "value": "0Ofbk1aSuVRu", + "value": "XpOYSgsLkTJy", "isInheritable": false, "position": 30 }, + { + "type": "relation", + "name": "internalLink", + "value": "0Ofbk1aSuVRu", + "isInheritable": false, + "position": 40 + }, { "type": "label", "name": "shareAlias", @@ -10171,13 +10178,6 @@ "value": "bx bx-selection", "isInheritable": false, "position": 20 - }, - { - "type": "relation", - "name": "internalLink", - "value": "SL5f1Auq7sVN", - "isInheritable": false, - "position": 40 } ], "format": "markdown", @@ -10839,39 +10839,53 @@ "type": "text", "mime": "text/html", "attributes": [ - { - "type": "label", - "name": "iconClass", - "value": "bx bxl-markdown", - "isInheritable": false, - "position": 30 - }, - { - "type": "label", - "name": "shareAlias", - "value": "markdown", - "isInheritable": false, - "position": 40 - }, { "type": "relation", "name": "internalLink", "value": "Oau6X9rCuegd", "isInheritable": false, - "position": 50 + "position": 10 }, { "type": "relation", "name": "internalLink", "value": "iPIMuisry3hd", "isInheritable": false, - "position": 60 + "position": 20 }, { "type": "relation", "name": "internalLink", "value": "6f9hih2hXXZk", "isInheritable": false, + "position": 30 + }, + { + "type": "relation", + "name": "internalLink", + "value": "SL5f1Auq7sVN", + "isInheritable": false, + "position": 40 + }, + { + "type": "relation", + "name": "internalLink", + "value": "nBAXQFj20hS1", + "isInheritable": false, + "position": 50 + }, + { + "type": "relation", + "name": "internalLink", + "value": "hrZ1D00cLbal", + "isInheritable": false, + "position": 60 + }, + { + "type": "relation", + "name": "internalLink", + "value": "m1lbrzyKDaRB", + "isInheritable": false, "position": 70 }, { @@ -10886,56 +10900,21 @@ "name": "internalLink", "value": "wy8So3yZZlH9", "isInheritable": false, - "position": 150 + "position": 90 }, { - "type": "relation", - "name": "internalLink", - "value": "SL5f1Auq7sVN", + "type": "label", + "name": "iconClass", + "value": "bx bxl-markdown", "isInheritable": false, - "position": 160 + "position": 30 }, { - "type": "relation", - "name": "internalLink", - "value": "NwBbFdNZ9h7O", + "type": "label", + "name": "shareAlias", + "value": "markdown", "isInheritable": false, - "position": 170 - }, - { - "type": "relation", - "name": "internalLink", - "value": "YfYAtQBcfo5V", - "isInheritable": false, - "position": 180 - }, - { - "type": "relation", - "name": "internalLink", - "value": "s1aBHPd79XYj", - "isInheritable": false, - "position": 190 - }, - { - "type": "relation", - "name": "internalLink", - "value": "nBAXQFj20hS1", - "isInheritable": false, - "position": 200 - }, - { - "type": "relation", - "name": "internalLink", - "value": "hrZ1D00cLbal", - "isInheritable": false, - "position": 210 - }, - { - "type": "relation", - "name": "internalLink", - "value": "m1lbrzyKDaRB", - "isInheritable": false, - "position": 220 + "position": 40 } ], "format": "markdown", diff --git a/docs/User Guide/User Guide/Basic Concepts and Features/Notes/Printing & Exporting as PDF.md b/docs/User Guide/User Guide/Basic Concepts and Features/Notes/Printing & Exporting as PDF.md index b110d09b03..221ba93c9a 100644 --- a/docs/User Guide/User Guide/Basic Concepts and Features/Notes/Printing & Exporting as PDF.md +++ b/docs/User Guide/User Guide/Basic Concepts and Features/Notes/Printing & Exporting as PDF.md @@ -99,9 +99,9 @@ To do so: For example, to change the font of the document from the one defined by the theme or the user to a serif one: ``` -body { - --main-font-family: serif !important; - --detail-font-family: var(--main-font-family) !important; +:root { + --print-font-family: serif; + --print-font-size: 11pt; } ``` diff --git a/docs/User Guide/User Guide/Installation & Setup/Data directory.md b/docs/User Guide/User Guide/Installation & Setup/Data directory.md index 3a447f82f2..b9df162b9e 100644 --- a/docs/User Guide/User Guide/Installation & Setup/Data directory.md +++ b/docs/User Guide/User Guide/Installation & Setup/Data directory.md @@ -97,4 +97,4 @@ Apart from the data directory, some of the subdirectories of it can be moved els | `TRILIUM_TMP_DIR` | `${TRILIUM_DATA_DIR}/tmp` | Directory where temporary files are stored (for example when opening in an external app). | | `TRILIUM_ANONYMIZED_DB_DIR` | `${TRILIUM_DATA_DIR}/anonymized-db` | Directory where a Anonymized Database is stored. | | `TRILIUM_CONFIG_INI_PATH` | `${TRILIUM_DATA_DIR}/config.ini` | Path to Configuration (config.ini or environment variables) file. | -| `TRILIUM_ELECTRON_DATA_DIR` | `${TRILIUM_DATA_DIR}/electron-user-data` (portable) or system appData (default) | Directory where Electron stores internal data such as caches and spell-check dictionaries (desktop only). | +| `TRILIUM_ELECTRON_DATA_DIR` | `${TRILIUM_DATA_DIR}/electron-user-data` (portable) or system appData (default) | Directory where Electron stores internal data such as caches and spell-check dictionaries (desktop only). | \ No newline at end of file diff --git a/docs/User Guide/User Guide/Note Types/Markdown.md b/docs/User Guide/User Guide/Note Types/Markdown.md index b96b627329..4913eb5f83 100644 --- a/docs/User Guide/User Guide/Note Types/Markdown.md +++ b/docs/User Guide/User Guide/Note Types/Markdown.md @@ -25,15 +25,12 @@ Even if Markdown is now specially treated by having a preview mechanism, Trilium The following features are supported by Trilium's Markdown format and will show up in the preview pane: * All standard and GitHub-flavored syntax (basic formatting, tables, blockquotes) -* Code blocks with syntax highlight (e.g. ` ```js `) and automatic syntax highlight -* Block quotes & admonitions -* Math Equations -* Mermaid Diagrams using ` ```mermaid ` +* Code blocks with syntax highlight (e.g. `mermaid` * Include Note (no builtin Markdown syntax, but HTML syntax works just fine): ```
    -   +  
    n ``` * Internal (reference) links via its HTML syntax, or through a _Wikilinks_\-like format (only Note ID):