Dockery/Trilium
1
0
Fork 0
mirror of https://github.com/zadam/trilium.git synced 2025-10-31 18:36:30 +01:00
Code Issues Packages Projects Releases Activity

docs(guide): improve and update supported syntax for Markdown import

Browse Source
This commit is contained in:
Elian Doran
2025-06-21 09:46:13 +03:00
parent 002c567ae9
commit 41e88614d7
14 changed files with 259 additions and 159 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
apps/server/src/assets/doc_notes/en/User Guide/!!!meta.json generated vendored
View File

File diff suppressed because one or more lines are too long

18
apps/server/src/assets/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/Import & Export/Markdown.html generated vendored
View File

@@ -42,19 +42,5 @@
This will export the notes in an unencrypted form, so if you reimport into This will export the notes in an unencrypted form, so if you reimport into
Trilium, make sure to re-protect these notes.</p> Trilium, make sure to re-protect these notes.</p>
<h2>Supported syntax</h2> <h2>Supported syntax</h2>
<ul> <p>See the dedicated page:&nbsp;<a class="reference-link" href="#root/pOsGYCXsbNQG/gh7bpGYxajRS/mHbBMPDPkVV5/Oau6X9rCuegd/_help_rJ9grSgoExl9">Supported syntax</a>
<li><a href="https://github.github.com/gfm/">GitHub-Flavored Markdown</a> is </p>
the main syntax that Trilium is following.</li>
<li>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.</li>
<li>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.</li>
<li><a class="reference-link" href="#root/_help_NwBbFdNZ9h7O">Admonitions</a>&nbsp;are
supported using GitHub's format.</li>
<li>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.</li>
<li>Math equations are supported using <code>$</code> and <code>$$</code> syntaxes.</li>
</ul>

54
apps/server/src/assets/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/Import & Export/Markdown/Supported syntax.html generated vendored Normal file
View File

@@ -0,0 +1,54 @@
<p><a href="https://github.github.com/gfm/">GitHub-Flavored Markdown</a> is
the main syntax that Trilium is following.</p>
<h2>Images</h2>
<p>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.</p>
<h2>Tables</h2>
<p>Simple 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.</p>
<h2>Links</h2>
<p>Standard Markdown links are supported.</p>
<p>Trilium internal links (that mirror a note's title and display its icon)
are embedded as HTML in order to preserve the information on import.</p>
<h2>Math equations</h2>
<p>Both inline and display equations are supported, using the <code>$</code> and <code>$$</code> syntaxes.</p>
<h2>Admonitions</h2>
<p>The Markdown syntax for admonitions as supported by Trilium is the one
that GitHub uses, which is as follows:</p><pre><code class="language-text-x-trilium-auto">&gt; [!NOTE]
&gt; This is a note.
&gt; [!TIP]
&gt; This is a tip.
&gt; [!IMPORTANT]
&gt; This is a very important information.
&gt; [!CAUTION]
&gt; This is a caution.</code></pre>
<p>There are currently no plans of supporting alternative admonition syntaxes
such as <code>!!! note</code>.</p>
<h2>Wikilinks</h2>
<p>Basic support for wikilinks has been added in v0.96.0:</p>
<ul>
<li><code>[[foo/bar]]</code> will look for the <code>bar.md</code> file in the <code>foo</code> directory
and turn it into an internal link.</li>
<li><code>![[foo/baz.png]]</code> will look for the <code>baz.png</code> file
in the <code>foo</code> directory and turn it into an image.</li>
</ul>
<p>This feature is import-only, which means that it will turn wikilinks into
Trilium-compatible syntax, but it will not export Trilium Notes into Markdown
files with this syntax.</p>
<aside class="admonition important">
<p>The path to pages in wikilinks is resolved relatively to the <em>import root </em>and
not the current directory of the note. This is to be inline with other
platforms that use wikilinks such as SilverBullet.</p>
<p>The root path of the import is determined as follows:</p>
<ul>
<li>If there is a single directory within the archive at root level, then
that directory is considered the root.</li>
<li>If there are multiple files &amp; directories at root level, then the
archive root (containing all of these items) is considered the root.</li>
</ul>
</aside>

7
apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text.html generated vendored
View File

@@ -153,13 +153,13 @@ class="table">
</td> </td>
</tr> </tr>
<tr> <tr>
<td><a class="reference-link" href="#root/pOsGYCXsbNQG/KSZ04uQ2D1St/iPIMuisry3hd/_help_gLt3vA97tMcp">Premium features</a> <td><a class="reference-link" href="#root/_help_gLt3vA97tMcp">Premium features</a>
</td> </td>
<td> <td>
<ul> <ul>
<li><a class="reference-link" href="#root/pOsGYCXsbNQG/KSZ04uQ2D1St/iPIMuisry3hd/gLt3vA97tMcp/_help_ZlN4nump6EbW">Slash Commands</a> <li><a class="reference-link" href="#root/_help_ZlN4nump6EbW">Slash Commands</a>
</li> </li>
<li><a class="reference-link" href="#root/pOsGYCXsbNQG/tC7s2alapj8V/_help_KC1HB96bqqHX">Templates</a> <li><a class="reference-link" href="#root/_help_KC1HB96bqqHX">Templates</a>
</li> </li>
</ul> </ul>
</td> </td>
@@ -167,6 +167,7 @@ class="table">
</tbody> </tbody>
</table> </table>
</figure> </figure>
<h2>Read-Only vs. Editing Mode</h2> <h2>Read-Only vs. Editing Mode</h2>
<p>Text notes are usually opened in edit mode. However, they may open in <p>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 read-only mode if the note is too big or the note is explicitly marked

15
apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Block quotes & admonitions.html generated vendored
View File

@@ -62,17 +62,4 @@ class="image image-style-align-center">
are currently no plans for adjusting it or allowing the user to customize are currently no plans for adjusting it or allowing the user to customize
them.</p> them.</p>
<h3>Markdown support</h3> <h3>Markdown support</h3>
<p>The Markdown syntax for admonitions as supported by Trilium is the one <p>See&nbsp;<a class="reference-link" href="#root/pOsGYCXsbNQG/gh7bpGYxajRS/mHbBMPDPkVV5/Oau6X9rCuegd/_help_rJ9grSgoExl9">Supported syntax</a>.</p>
that GitHub uses, which is as follows:</p><pre><code class="language-text-x-trilium-auto">&gt; [!NOTE]
&gt; This is a note.
&gt; [!TIP]
&gt; This is a tip.
&gt; [!IMPORTANT]
&gt; This is a very important information.
&gt; [!CAUTION]
&gt; This is a caution.</code></pre>
<p>There are currently no plans of supporting alternative admonition syntaxes
such as <code>!!! note</code>.</p>

11
apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Premium features.html generated vendored
View File

@@ -1,4 +1,4 @@
<p>The text editor we are using for <a class="reference-link" href="#root/pOsGYCXsbNQG/KSZ04uQ2D1St/_help_iPIMuisry3hd">Text</a> notes <p>The text editor we are using for&nbsp;<a class="reference-link" href="#root/_help_iPIMuisry3hd">Text</a>&nbsp;notes
is called CKEditor and it's a commercial product. The core components are is called CKEditor and it's a commercial product. The core components are
open-source, however they <a href="https://ckeditor.com/docs/trial/latest/index.html">offer quite a few features</a> that open-source, however they <a href="https://ckeditor.com/docs/trial/latest/index.html">offer quite a few features</a> that
require a commercial license in order to be used.</p> require a commercial license in order to be used.</p>
@@ -6,12 +6,13 @@
in order to have some of these extra features and they have agreed, based in order to have some of these extra features and they have agreed, based
on a signed agreement.</p> on a signed agreement.</p>
<h2>How the license works</h2> <h2>How the license works</h2>
<p>The license key is stored in the application and it enables the use of <p>The license key is stored in the application and it enables the use of
the previously described premium features. The license key has an expiration the previously described premium features. The license key has an expiration
date which means that the features can become disabled if using an older date which means that the features can become disabled if using an older
version of the application for extended periods of time.</p> version of the application for extended periods of time.</p>
<h2>Can I opt out of these features?</h2> <h2>Can I opt out of these features?</h2>
<p>At this moment there is no way to disable these features, apart from manually
<p>At this moment there is no way to disable this features, apart from manually modifying the source code. If this is a problem, <a href="#root/_help_wy8So3yZZlH9">let us know</a>.</p>
modifying the source code. If this is a problem, <a href="#root/pOsGYCXsbNQG/BgmBlOIl72jZ/_help_wy8So3yZZlH9">let us know</a>.</p> <p>If you have the possibility of rebuilding the source code (e.g. if a package
maintainer), then modify <code>VITE_CKEDITOR_KEY</code> in <code>apps/client/.env</code> to
be <code>GPL</code>.</p>

23
apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Premium features/Slash Commands.html generated vendored
View File

@@ -1,18 +1,18 @@
<figure class="image image-style-align-right"> <figure class="image image-style-align-right">
<img style="aspect-ratio:419/571" src="Slash Commands_image.png" width="419" <img style="aspect-ratio:419/571;" src="Slash Commands_image.png" width="419"
height="571" /> height="571">
</figure> </figure>
<aside class="admonition note"> <aside class="admonition note">
<p>This is a premium feature of the editor we are using (CKEditor) and we <p>This is a premium feature of the editor we are using (CKEditor) and we
benefit from it thanks to an written agreement with the team. See  <a class="reference-link" benefit from it thanks to an written agreement with the team. See&nbsp;
href="#root/_help_gLt3vA97tMcp">Premium features</a> for more information.</p> <a
class="reference-link" href="#root/_help_gLt3vA97tMcp">Premium features</a>&nbsp;for more information.</p>
</aside> </aside>
<p>Slash commands is a feature of <a class="reference-link" href="#root/pOsGYCXsbNQG/KSZ04uQ2D1St/_help_iPIMuisry3hd">Text</a> notes <p>Slash commands is a feature of&nbsp;<a class="reference-link" href="#root/_help_iPIMuisry3hd">Text</a>&nbsp;notes
which allows easily accessing commonly used commands simply by using the which allows easily accessing commonly used commands simply by using the
keyboard, without having to remember dedicated <a class="reference-link" keyboard, without having to remember dedicated&nbsp;<a class="reference-link"
href="#root/pOsGYCXsbNQG/gh7bpGYxajRS/_help_A9Oc6YKKc65v">Keyboard Shortcuts</a>.</p> href="#root/_help_A9Oc6YKKc65v">Keyboard Shortcuts</a>.</p>
<h2>Interaction</h2> <h2>Interaction</h2>
<ul> <ul>
<li>As the name suggests, to trigger the slash commands simply press the <kbd>/</kbd> key <li>As the name suggests, to trigger the slash commands simply press the <kbd>/</kbd> key
to trigger it. Note that this can be anywhere in a paragraph as long as to trigger it. Note that this can be anywhere in a paragraph as long as
@@ -24,12 +24,11 @@
<li>To trigger an action, press the <kbd>Enter</kbd> key.</li> <li>To trigger an action, press the <kbd>Enter</kbd> key.</li>
</ul> </ul>
<h2>Integration with other features</h2> <h2>Integration with other features</h2>
<p>Apart from the common set of commands, some features are specially integrated <p>Apart from the common set of commands, some features are specially integrated
with the slash commands:</p> with the slash commands:</p>
<ul> <ul>
<li>For <a href="#root/pOsGYCXsbNQG/KSZ04uQ2D1St/iPIMuisry3hd/_help_NwBbFdNZ9h7O">admonitions</a>, <li>For <a href="#root/_help_NwBbFdNZ9h7O">admonitions</a>, each admonition
each admonition type (e.g. note, tip) will be individually displayed.</li> type (e.g. note, tip) will be individually displayed.</li>
<li>Every <a class="reference-link" href="#root/_help_pwc194wlRzcH">Text Snippets</a> will <li>Every&nbsp;<a class="reference-link" href="#root/_help_pwc194wlRzcH">Text Snippets</a>&nbsp;will
also appear individually, making it easy to insert them.</li> also appear individually, making it easy to insert them.</li>
</ul> </ul>

33
apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Premium features/Text Snippets.html generated vendored
View File

@@ -1,18 +1,18 @@
<figure class="image image-style-align-right"> <figure class="image image-style-align-right">
<img style="aspect-ratio:265/108" src="Text Snippets_image.png" width="265" <img style="aspect-ratio:265/108;" src="Text Snippets_image.png" width="265"
height="108" /> height="108">
</figure> </figure>
<aside class="admonition note"> <aside class="admonition note">
<p>This is a premium feature of the editor we are using (CKEditor) and we <p>This is a premium feature of the editor we are using (CKEditor) and we
benefit from it thanks to an written agreement with the team. See  <a class="reference-link" benefit from it thanks to an written agreement with the team. See&nbsp;
href="#root/_help_gLt3vA97tMcp">Premium features</a> for more information.</p> <a
class="reference-link" href="#root/_help_gLt3vA97tMcp">Premium features</a>&nbsp;for more information.</p>
</aside> </aside>
<p>Text Snippets are closely related to <a class="reference-link" href="#root/pOsGYCXsbNQG/tC7s2alapj8V/_help_KC1HB96bqqHX">Templates</a>, <p>Text Snippets are closely related to&nbsp;<a class="reference-link" href="#root/_help_KC1HB96bqqHX">Templates</a>,
but instead of defining the content of an entire note, text snippets are but instead of defining the content of an entire note, text snippets are
pieces of formatted text that can easily be inserted in a text note.</p> pieces of formatted text that can easily be inserted in a text note.</p>
<h2>Creating a text snippet</h2> <h2>Creating a text snippet</h2>
<p>In the&nbsp;<a class="reference-link" href="#root/_help_oPVyFC7WL2Lp">Note Tree</a>: </p>
<p>In the <a class="reference-link" href="#root/pOsGYCXsbNQG/gh7bpGYxajRS/Vc8PjrjAGuOp/_help_oPVyFC7WL2Lp">Note Tree</a>: </p>
<ol> <ol>
<li>Right click a note where to place the text snippet.</li> <li>Right click a note where to place the text snippet.</li>
<li>Select <em>Insert child note</em>.</li> <li>Select <em>Insert child note</em>.</li>
@@ -21,16 +21,14 @@
<p>Afterwards, simply type in the content of the note the desired text. The <p>Afterwards, simply type in the content of the note the desired text. The
text can be formatted in the same manner as a normal text note.</p> text can be formatted in the same manner as a normal text note.</p>
<p>The title of the note will become the title of the template. Optionally, <p>The title of the note will become the title of the template. Optionally,
a description can be added in the <a class="reference-link" href="#root/pOsGYCXsbNQG/tC7s2alapj8V/zEY4DaJG4YT5/_help_OFXdgB2nNk1F">Promoted Attributes</a> section.</p> a description can be added in the&nbsp;<a class="reference-link" href="#root/_help_OFXdgB2nNk1F">Promoted Attributes</a>&nbsp;section.</p>
<h2>Inserting a snippet</h2> <h2>Inserting a snippet</h2>
<p>Once a snippet is created, there are two options to insert it:</p> <p>Once a snippet is created, there are two options to insert it:</p>
<ol> <ol>
<li>From the <a class="reference-link" href="#root/pOsGYCXsbNQG/KSZ04uQ2D1St/iPIMuisry3hd/_help_nRhnJkTT8cPs">Formatting toolbar</a>, <li>From the&nbsp;<a class="reference-link" href="#root/_help_nRhnJkTT8cPs">Formatting toolbar</a>,
by looking for the by looking for the
<img src="1_Text Snippets_image.png" width="19" height="19" <img src="1_Text Snippets_image.png" width="19" height="19">button.</li>
/>button.</li> <li>Using&nbsp;<a class="reference-link" href="#root/_help_ZlN4nump6EbW">Slash Commands</a>: 
<li>Using <a class="reference-link" href="#root/_help_ZlN4nump6EbW">Slash Commands</a>: 
<ol> <ol>
<li>To look for a specific template, start typing the name of the template <li>To look for a specific template, start typing the name of the template
(its title).</li> (its title).</li>
@@ -41,16 +39,15 @@
<aside class="admonition tip"> <aside class="admonition tip">
<p>A newly created snippet doesn't appear? Generally it takes up to a few <p>A newly created snippet doesn't appear? Generally it takes up to a few
seconds to refresh the list of templates once you make a change.</p> seconds to refresh the list of templates once you make a change.</p>
<p>If this doesn't happen, <a href="#root/pOsGYCXsbNQG/BgmBlOIl72jZ/_help_s8alTXmpFR61">reload the application</a> and <p>If this doesn't happen, <a href="#root/_help_s8alTXmpFR61">reload the application</a> and
<a <a
href="#root/pOsGYCXsbNQG/BgmBlOIl72jZ/_help_wy8So3yZZlH9">report the issue</a>to us. </p> href="#root/_help_wy8So3yZZlH9">report the issue</a>to us.&nbsp;</p>
</aside> </aside>
<h2>Limitations</h2> <h2>Limitations</h2>
<ul> <ul>
<li>Whenever a snippet is created, deleted or its title/description are modified, <li>Whenever a snippet is created, deleted or its title/description are modified,
all the open text notes will need to be refreshed. This causes a slight all the open text notes will need to be refreshed. This causes a slight
flash for usually under a second, but it can cause some discomfort.</li> flash for usually under a second, but it can cause some discomfort.</li>
<li>Unlike <a class="reference-link" href="#root/pOsGYCXsbNQG/tC7s2alapj8V/_help_KC1HB96bqqHX">Templates</a>, <li>Unlike&nbsp;<a class="reference-link" href="#root/_help_KC1HB96bqqHX">Templates</a>,
the snippets cannot be limited to a particular <a href="#root/pOsGYCXsbNQG/gh7bpGYxajRS/wArbEsdSae6g/_help_9sRHySam5fXb">workspace</a>.</li> the snippets cannot be limited to a particular <a href="#root/_help_9sRHySam5fXb">workspace</a>.</li>
</ul> </ul>

153
docs/User Guide/!!!meta.json vendored
View File

@@ -4350,13 +4350,6 @@
"type": "text", "type": "text",
"mime": "text/markdown", "mime": "text/markdown",
"attributes": [ "attributes": [
{
"type": "relation",
"name": "internalLink",
"value": "NwBbFdNZ9h7O",
"isInheritable": false,
"position": 10
},
{ {
"type": "label", "type": "label",
"name": "shareAlias", "name": "shareAlias",
@@ -4370,6 +4363,13 @@
"value": "bx bxl-markdown", "value": "bx bxl-markdown",
"isInheritable": false, "isInheritable": false,
"position": 50 "position": 50
},
{
"type": "relation",
"name": "internalLink",
"value": "rJ9grSgoExl9",
"isInheritable": false,
"position": 60
} }
], ],
"format": "markdown", "format": "markdown",
@@ -4407,6 +4407,38 @@
"position": 10, "position": 10,
"dataFileName": "Markdown_markdown-inline-i.gif" "dataFileName": "Markdown_markdown-inline-i.gif"
} }
],
"dirFileName": "Markdown",
"children": [
{
"isClone": false,
"noteId": "rJ9grSgoExl9",
"notePath": [
"pOsGYCXsbNQG",
"gh7bpGYxajRS",
"mHbBMPDPkVV5",
"Oau6X9rCuegd",
"rJ9grSgoExl9"
],
"title": "Supported syntax",
"notePosition": 10,
"prefix": null,
"isExpanded": false,
"type": "text",
"mime": "text/html",
"attributes": [
{
"type": "label",
"name": "iconClass",
"value": "bx bx-code-alt",
"isInheritable": false,
"position": 10
}
],
"format": "markdown",
"dataFileName": "Supported syntax.md",
"attachments": []
}
] ]
}, },
{ {
@@ -4957,31 +4989,52 @@
{ {
"type": "relation", "type": "relation",
"name": "internalLink", "name": "internalLink",
"value": "CoFPLs3dRlXc", "value": "gLt3vA97tMcp",
"isInheritable": false, "isInheritable": false,
"position": 150 "position": 150
}, },
{ {
"type": "relation", "type": "relation",
"name": "internalLink", "name": "internalLink",
"value": "A9Oc6YKKc65v", "value": "ZlN4nump6EbW",
"isInheritable": false, "isInheritable": false,
"position": 160 "position": 160
}, },
{ {
"type": "relation", "type": "relation",
"name": "internalLink", "name": "internalLink",
"value": "QrtTYPmdd1qq", "value": "KC1HB96bqqHX",
"isInheritable": false, "isInheritable": false,
"position": 170 "position": 170
}, },
{ {
"type": "relation", "type": "relation",
"name": "internalLink", "name": "internalLink",
"value": "MI26XDLSAlCD", "value": "CoFPLs3dRlXc",
"isInheritable": false, "isInheritable": false,
"position": 180 "position": 180
}, },
{
"type": "relation",
"name": "internalLink",
"value": "A9Oc6YKKc65v",
"isInheritable": false,
"position": 190
},
{
"type": "relation",
"name": "internalLink",
"value": "QrtTYPmdd1qq",
"isInheritable": false,
"position": 200
},
{
"type": "relation",
"name": "internalLink",
"value": "MI26XDLSAlCD",
"isInheritable": false,
"position": 210
},
{ {
"type": "label", "type": "label",
"name": "shareAlias", "name": "shareAlias",
@@ -5009,27 +5062,6 @@
"value": "", "value": "",
"isInheritable": false, "isInheritable": false,
"position": 40 "position": 40
},
{
"type": "relation",
"name": "internalLink",
"value": "gLt3vA97tMcp",
"isInheritable": false,
"position": 190
},
{
"type": "relation",
"name": "internalLink",
"value": "ZlN4nump6EbW",
"isInheritable": false,
"position": 200
},
{
"type": "relation",
"name": "internalLink",
"value": "KC1HB96bqqHX",
"isInheritable": false,
"position": 210
} }
], ],
"format": "markdown", "format": "markdown",
@@ -5091,6 +5123,13 @@
"value": "bx bx-info-circle", "value": "bx bx-info-circle",
"isInheritable": false, "isInheritable": false,
"position": 10 "position": 10
},
{
"type": "relation",
"name": "internalLink",
"value": "rJ9grSgoExl9",
"isInheritable": false,
"position": 20
} }
], ],
"format": "markdown", "format": "markdown",
@@ -6741,7 +6780,7 @@
"name": "internalLink", "name": "internalLink",
"value": "wy8So3yZZlH9", "value": "wy8So3yZZlH9",
"isInheritable": false, "isInheritable": false,
"position": 10 "position": 20
}, },
{ {
"type": "label", "type": "label",
@@ -6785,28 +6824,28 @@
"name": "internalLink", "name": "internalLink",
"value": "iPIMuisry3hd", "value": "iPIMuisry3hd",
"isInheritable": false, "isInheritable": false,
"position": 10 "position": 20
}, },
{ {
"type": "relation", "type": "relation",
"name": "internalLink", "name": "internalLink",
"value": "A9Oc6YKKc65v", "value": "A9Oc6YKKc65v",
"isInheritable": false, "isInheritable": false,
"position": 10 "position": 30
}, },
{ {
"type": "relation", "type": "relation",
"name": "internalLink", "name": "internalLink",
"value": "NwBbFdNZ9h7O", "value": "NwBbFdNZ9h7O",
"isInheritable": false, "isInheritable": false,
"position": 10 "position": 40
}, },
{ {
"type": "relation", "type": "relation",
"name": "internalLink", "name": "internalLink",
"value": "pwc194wlRzcH", "value": "pwc194wlRzcH",
"isInheritable": false, "isInheritable": false,
"position": 20 "position": 50
}, },
{ {
"type": "label", "type": "label",
@@ -6858,56 +6897,56 @@
"name": "internalLink", "name": "internalLink",
"value": "KC1HB96bqqHX", "value": "KC1HB96bqqHX",
"isInheritable": false, "isInheritable": false,
"position": 10 "position": 20
}, },
{ {
"type": "relation", "type": "relation",
"name": "internalLink", "name": "internalLink",
"value": "oPVyFC7WL2Lp", "value": "oPVyFC7WL2Lp",
"isInheritable": false, "isInheritable": false,
"position": 10 "position": 30
}, },
{ {
"type": "relation", "type": "relation",
"name": "internalLink", "name": "internalLink",
"value": "OFXdgB2nNk1F", "value": "OFXdgB2nNk1F",
"isInheritable": false, "isInheritable": false,
"position": 10 "position": 40
}, },
{ {
"type": "relation", "type": "relation",
"name": "internalLink", "name": "internalLink",
"value": "nRhnJkTT8cPs", "value": "nRhnJkTT8cPs",
"isInheritable": false, "isInheritable": false,
"position": 10 "position": 50
}, },
{ {
"type": "relation", "type": "relation",
"name": "internalLink", "name": "internalLink",
"value": "ZlN4nump6EbW", "value": "ZlN4nump6EbW",
"isInheritable": false, "isInheritable": false,
"position": 10 "position": 60
},
{
"type": "relation",
"name": "internalLink",
"value": "s8alTXmpFR61",
"isInheritable": false,
"position": 10
},
{
"type": "relation",
"name": "internalLink",
"value": "wy8So3yZZlH9",
"isInheritable": false,
"position": 10
}, },
{ {
"type": "relation", "type": "relation",
"name": "internalLink", "name": "internalLink",
"value": "9sRHySam5fXb", "value": "9sRHySam5fXb",
"isInheritable": false, "isInheritable": false,
"position": 10 "position": 70
},
{
"type": "relation",
"name": "internalLink",
"value": "s8alTXmpFR61",
"isInheritable": false,
"position": 80
},
{
"type": "relation",
"name": "internalLink",
"value": "wy8So3yZZlH9",
"isInheritable": false,
"position": 90
}, },
{ {
"type": "label", "type": "label",

7
docs/User Guide/User Guide/Basic Concepts and Features/Import & Export/Markdown.md vendored
View File

@@ -42,9 +42,4 @@ If you want to export protected notes, enter a protected session first! This wil
## Supported syntax ## Supported syntax
* [GitHub-Flavored Markdown](https://github.github.com/gfm/) is the main syntax that Trilium is following. See the dedicated page: <a class="reference-link" href="Markdown/Supported%20syntax.md">Supported syntax</a>
* 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.
* <a class="reference-link" href="../../Note%20Types/Text/Block%20quotes%20%26%20admonitions.md">Admonitions</a> 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.

57
docs/User Guide/User Guide/Basic Concepts and Features/Import & Export/Markdown/Supported syntax.md vendored Normal file
View File

@@ -0,0 +1,57 @@
# Supported syntax
[GitHub-Flavored Markdown](https://github.github.com/gfm/) is the main syntax that Trilium is following.
## Images
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
Simple 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.
## Links
Standard Markdown links are supported.
Trilium 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
Both inline and display equations are supported, using the `$` and `$$` syntaxes.
## Admonitions
The Markdown syntax for admonitions as supported by Trilium is the one that GitHub uses, which is as follows:
```
> [!NOTE]
> This is a note.
> [!TIP]
> This is a tip.
> [!IMPORTANT]
> This is a very important information.
> [!CAUTION]
> This is a caution.
```
There are currently no plans of supporting alternative admonition syntaxes such as `!!! note`.
## Wikilinks
Basic support for wikilinks has been added in v0.96.0:
* `[[foo/bar]]` will look for the `bar.md` file in the `foo` directory and turn it into an internal link.
* `![[foo/baz.png]]` will look for the `baz.png` file in the `foo` directory and turn it into an image.
This feature is import-only, which means that it will turn wikilinks into Trilium-compatible syntax, but it will not export Trilium Notes into Markdown files with this syntax.
> [!IMPORTANT]
> The path to pages in wikilinks is resolved relatively to the _import root_ and not the current directory of the note. This is to be inline with other platforms that use wikilinks such as SilverBullet.
>
> The root path of the import is determined as follows:
>
> * If there is a single directory within the archive at root level, then that directory is considered the root.
> * If there are multiple files & directories at root level, then the archive root (containing all of these items) is considered the root.

18
docs/User Guide/User Guide/Note Types/Text/Block quotes & admonitions.md vendored
View File

@@ -52,20 +52,4 @@ These types were inspired by GitHub's support for this feature and there are cur
### Markdown support ### Markdown support
The Markdown syntax for admonitions as supported by Trilium is the one that GitHub uses, which is as follows: See <a class="reference-link" href="../../Basic%20Concepts%20and%20Features/Import%20%26%20Export/Markdown/Supported%20syntax.md">Supported syntax</a>.
```
> [!NOTE]
> This is a note.
> [!TIP]
> This is a tip.
> [!IMPORTANT]
> This is a very important information.
> [!CAUTION]
> This is a caution.
```
There are currently no plans of supporting alternative admonition syntaxes such as `!!! note`.

2
docs/User Guide/User Guide/Note Types/Text/Premium features/Slash Commands.md vendored
View File

@@ -1,5 +1,5 @@
# Slash Commands # Slash Commands
<figure class="image image-style-align-right"><img style="aspect-ratio:419/571" src="Slash Commands_image.png" width="419" height="571"></figure> <figure class="image image-style-align-right"><img style="aspect-ratio:419/571;" src="Slash Commands_image.png" width="419" height="571"></figure>
> [!NOTE] > [!NOTE]
> This is a premium feature of the editor we are using (CKEditor) and we benefit from it thanks to an written agreement with the team. See  <a class="reference-link" href="../Premium%20features.md">Premium features</a> for more information. > This is a premium feature of the editor we are using (CKEditor) and we benefit from it thanks to an written agreement with the team. See  <a class="reference-link" href="../Premium%20features.md">Premium features</a> for more information.

2
docs/User Guide/User Guide/Note Types/Text/Premium features/Text Snippets.md vendored
View File

@@ -1,5 +1,5 @@
# Text Snippets # Text Snippets
<figure class="image image-style-align-right"><img style="aspect-ratio:265/108" src="Text Snippets_image.png" width="265" height="108"></figure> <figure class="image image-style-align-right"><img style="aspect-ratio:265/108;" src="Text Snippets_image.png" width="265" height="108"></figure>
> [!NOTE] > [!NOTE]
> This is a premium feature of the editor we are using (CKEditor) and we benefit from it thanks to an written agreement with the team. See  <a class="reference-link" href="../Premium%20features.md">Premium features</a> for more information. > This is a premium feature of the editor we are using (CKEditor) and we benefit from it thanks to an written agreement with the team. See  <a class="reference-link" href="../Premium%20features.md">Premium features</a> for more information.