diff --git a/docs/User Guide/!!!meta.json b/docs/User Guide/!!!meta.json index fe08afb95..9cc7a0824 100644 --- a/docs/User Guide/!!!meta.json +++ b/docs/User Guide/!!!meta.json @@ -1933,39 +1933,39 @@ "mime": "text/html", "attributes": [ { - "type": "label", - "name": "iconClass", - "value": "bx bxs-dock-right", + "type": "relation", + "name": "internalLink", + "value": "BFvAtE74rbP6", "isInheritable": false, "position": 10 }, { "type": "relation", "name": "internalLink", - "value": "BFvAtE74rbP6", + "value": "AxshuNRegLAv", "isInheritable": false, "position": 20 }, { "type": "relation", "name": "internalLink", - "value": "AxshuNRegLAv", + "value": "luNhaphA37EO", "isInheritable": false, "position": 30 }, { "type": "relation", "name": "internalLink", - "value": "luNhaphA37EO", + "value": "3seOhtN8uLIY", "isInheritable": false, "position": 40 }, { - "type": "relation", - "name": "internalLink", - "value": "3seOhtN8uLIY", + "type": "label", + "name": "iconClass", + "value": "bx bxs-dock-right", "isInheritable": false, - "position": 50 + "position": 10 } ], "format": "markdown", @@ -3642,6 +3642,13 @@ "value": "bx bxl-markdown", "isInheritable": false, "position": 50 + }, + { + "type": "relation", + "name": "internalLink", + "value": "NwBbFdNZ9h7O", + "isInheritable": false, + "position": 60 } ], "format": "markdown", @@ -4624,46 +4631,39 @@ "mime": "text/html", "attributes": [ { - "type": "label", - "name": "iconClass", - "value": "bx bx-highlight", + "type": "relation", + "name": "internalLink", + "value": "RnaPdbciOfeq", "isInheritable": false, "position": 10 }, { "type": "relation", "name": "internalLink", - "value": "BFvAtE74rbP6", + "value": "XpOYSgsLkTJy", "isInheritable": false, "position": 20 }, { "type": "relation", "name": "internalLink", - "value": "RnaPdbciOfeq", + "value": "zEY4DaJG4YT5", "isInheritable": false, "position": 30 }, { "type": "relation", "name": "internalLink", - "value": "_optionsTextNotes", + "value": "BFvAtE74rbP6", "isInheritable": false, "position": 40 }, { - "type": "relation", - "name": "internalLink", - "value": "zEY4DaJG4YT5", + "type": "label", + "name": "iconClass", + "value": "bx bx-highlight", "isInheritable": false, - "position": 50 - }, - { - "type": "relation", - "name": "internalLink", - "value": "XpOYSgsLkTJy", - "isInheritable": false, - "position": 60 + "position": 10 } ], "format": "markdown", @@ -5100,37 +5100,30 @@ { "type": "relation", "name": "internalLink", - "value": "XpOYSgsLkTJy", + "value": "RnaPdbciOfeq", "isInheritable": false, "position": 10 }, { "type": "relation", "name": "internalLink", - "value": "_optionsTextNotes", + "value": "XpOYSgsLkTJy", "isInheritable": false, "position": 20 }, + { + "type": "relation", + "name": "internalLink", + "value": "zEY4DaJG4YT5", + "isInheritable": false, + "position": 30 + }, { "type": "label", "name": "iconClass", "value": "bx bx-heading", "isInheritable": false, "position": 30 - }, - { - "type": "relation", - "name": "internalLink", - "value": "zEY4DaJG4YT5", - "isInheritable": false, - "position": 40 - }, - { - "type": "relation", - "name": "internalLink", - "value": "RnaPdbciOfeq", - "isInheritable": false, - "position": 50 } ], "format": "markdown", diff --git a/docs/User Guide/User Guide/Basic Concepts and Features/Import & Export/Markdown.md b/docs/User Guide/User Guide/Basic Concepts and Features/Import & Export/Markdown.md index 50d10235d..de502a143 100644 --- a/docs/User Guide/User Guide/Basic Concepts and Features/Import & Export/Markdown.md +++ b/docs/User Guide/User Guide/Basic Concepts and Features/Import & Export/Markdown.md @@ -1,5 +1,5 @@ # Markdown -Trilium Notes supports importing Markdown restricted to the [CommonMark specification](https://spec.commonmark.org/current/) (where [tables are not supported](https://github.com/TriliumNext/Notes/issues/2026)) +Trilium supports Markdown for both import and export, while trying to keep compatibility as high as possible. ## Import @@ -38,4 +38,13 @@ If you want to export just single note without its subtree, you can do it from N ### Exporting protected notes -If you want to export protected notes, enter a protected session first! This will export the notes in an unencrypted form, so if you reimport into Trilium, make sure to re-protect these notes. \ No newline at end of file +If you want to export protected notes, enter a protected session first! This will export the notes in an unencrypted form, so if you reimport into Trilium, make sure to re-protect these notes. + +## Supported syntax + +* [GitHub-Flavored Markdown](https://github.github.com/gfm/) is the main syntax that Trilium is following. +* Images are supported. When exporting, images are usually kept in the basic Markdown syntax but will use the HTML syntax if the image has a custom width. Figures are always embedded as HTML. +* Tables are supported with the Markdown syntax. If the table is too complex or contains elements that would render as HTML, the table is also rendered as HTML. +* Admonitions are supported using GitHub's format. +* Links are supported. “Reference links” (internal links that mirror a note's title and display its icon) are embedded as HTML in order to preserve the information on import. +* Math equations are supported using `$` and `$$` syntaxes. \ No newline at end of file diff --git a/src/public/app/doc_notes/en/User Guide/!!!meta.json b/src/public/app/doc_notes/en/User Guide/!!!meta.json index 356b29b42..880c537f6 100644 --- a/src/public/app/doc_notes/en/User Guide/!!!meta.json +++ b/src/public/app/doc_notes/en/User Guide/!!!meta.json @@ -1933,39 +1933,39 @@ "mime": "text/html", "attributes": [ { - "type": "label", - "name": "iconClass", - "value": "bx bxs-dock-right", + "type": "relation", + "name": "internalLink", + "value": "BFvAtE74rbP6", "isInheritable": false, "position": 10 }, { "type": "relation", "name": "internalLink", - "value": "BFvAtE74rbP6", + "value": "AxshuNRegLAv", "isInheritable": false, "position": 20 }, { "type": "relation", "name": "internalLink", - "value": "AxshuNRegLAv", + "value": "luNhaphA37EO", "isInheritable": false, "position": 30 }, { "type": "relation", "name": "internalLink", - "value": "luNhaphA37EO", + "value": "3seOhtN8uLIY", "isInheritable": false, "position": 40 }, { - "type": "relation", - "name": "internalLink", - "value": "3seOhtN8uLIY", + "type": "label", + "name": "iconClass", + "value": "bx bxs-dock-right", "isInheritable": false, - "position": 50 + "position": 10 } ], "format": "html", @@ -3642,6 +3642,13 @@ "value": "bx bxl-markdown", "isInheritable": false, "position": 50 + }, + { + "type": "relation", + "name": "internalLink", + "value": "NwBbFdNZ9h7O", + "isInheritable": false, + "position": 60 } ], "format": "html", @@ -4624,46 +4631,39 @@ "mime": "text/html", "attributes": [ { - "type": "label", - "name": "iconClass", - "value": "bx bx-highlight", + "type": "relation", + "name": "internalLink", + "value": "RnaPdbciOfeq", "isInheritable": false, "position": 10 }, { "type": "relation", "name": "internalLink", - "value": "BFvAtE74rbP6", + "value": "XpOYSgsLkTJy", "isInheritable": false, "position": 20 }, { "type": "relation", "name": "internalLink", - "value": "RnaPdbciOfeq", + "value": "zEY4DaJG4YT5", "isInheritable": false, "position": 30 }, { "type": "relation", "name": "internalLink", - "value": "_optionsTextNotes", + "value": "BFvAtE74rbP6", "isInheritable": false, "position": 40 }, { - "type": "relation", - "name": "internalLink", - "value": "zEY4DaJG4YT5", + "type": "label", + "name": "iconClass", + "value": "bx bx-highlight", "isInheritable": false, - "position": 50 - }, - { - "type": "relation", - "name": "internalLink", - "value": "XpOYSgsLkTJy", - "isInheritable": false, - "position": 60 + "position": 10 } ], "format": "html", @@ -5100,37 +5100,30 @@ { "type": "relation", "name": "internalLink", - "value": "XpOYSgsLkTJy", + "value": "RnaPdbciOfeq", "isInheritable": false, "position": 10 }, { "type": "relation", "name": "internalLink", - "value": "_optionsTextNotes", + "value": "XpOYSgsLkTJy", "isInheritable": false, "position": 20 }, + { + "type": "relation", + "name": "internalLink", + "value": "zEY4DaJG4YT5", + "isInheritable": false, + "position": 30 + }, { "type": "label", "name": "iconClass", "value": "bx bx-heading", "isInheritable": false, "position": 30 - }, - { - "type": "relation", - "name": "internalLink", - "value": "zEY4DaJG4YT5", - "isInheritable": false, - "position": 40 - }, - { - "type": "relation", - "name": "internalLink", - "value": "RnaPdbciOfeq", - "isInheritable": false, - "position": 50 } ], "format": "html", diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/Import & Export/Markdown.html b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/Import & Export/Markdown.html index fa4063b4f..22d071fdf 100644 --- a/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/Import & Export/Markdown.html +++ b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/Import & Export/Markdown.html @@ -13,9 +13,8 @@

Markdown

-

Trilium Notes supports importing Markdown restricted to the CommonMark specification (where - tables are not supported)

+

Trilium supports Markdown for both import and export, while trying to + keep compatibility as high as possible.

Import

Clipboard import

If you want to import just a chunk of markdown from clipboard, you can @@ -57,6 +56,23 @@

If you want to export protected notes, enter a protected session first! This will export the notes in an unencrypted form, so if you reimport into Trilium, make sure to re-protect these notes.

+

Supported syntax

+