mirror of
https://github.com/zadam/trilium.git
synced 2025-10-01 19:15:31 +08:00
docs: sync changes to repo URL
This commit is contained in:
Elian Doran
parent
f740edae91
commit
70b1a37285
18 changed files with 46 additions and 47 deletions
|
|
@ -1,7 +1,7 @@
|
|||
<p>Trilium supports configuration via a file named <code>config.ini</code> and
|
||||
environment variables. Please review the file named <a href="https://github.com/TriliumNext/Notes/blob/develop/apps/server/src/assets/config-sample.ini">config-sample.ini</a> in
|
||||
the <a href="https://github.com/TriliumNext/Notes">Notes</a> repository to
|
||||
see what values are supported.</p>
|
||||
environment variables. Please review the file named <a href="https://github.com/TriliumNext/Trilium/blob/develop/apps/server/src/assets/config-sample.ini">config-sample.ini</a> in
|
||||
the <a href="https://github.com/TriliumNext/Trilium">Notes</a> repository
|
||||
to see what values are supported.</p>
|
||||
<p>You can provide the same values via environment variables instead of the <code>config.ini</code> file,
|
||||
and these environment variables use the following format:</p>
|
||||
<ol>
|
||||
|
|
|
|||
|
|
@ -21,7 +21,7 @@
|
|||
<p>You can easily restore the demo notes by using Trilium's built-in import
|
||||
feature by importing them:</p>
|
||||
<ul>
|
||||
<li>Download <a href="https://github.com/TriliumNext/Notes/raw/develop/db/demo.zip">this .zip archive</a> with
|
||||
<li>Download <a href="https://github.com/TriliumNext/Trilium/raw/develop/db/demo.zip">this .zip archive</a> with
|
||||
the latest version of the demo notes</li>
|
||||
<li>Right click on any note in your tree under which you would like the demo
|
||||
notes to be imported</li>
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
<p>ETAPI is Trilium's public/external REST API. It is available since Trilium
|
||||
v0.50.</p>
|
||||
<p>The documentation is in OpenAPI format, available <a href="https://github.com/TriliumNext/Notes/blob/master/src/etapi/etapi.openapi.yaml">here</a>.</p>
|
||||
<p>The documentation is in OpenAPI format, available <a href="https://github.com/TriliumNext/Trilium/blob/master/src/etapi/etapi.openapi.yaml">here</a>.</p>
|
||||
<h2>API clients</h2>
|
||||
<p>As an alternative to calling the API directly, there are client libraries
|
||||
to simplify this</p>
|
||||
|
|
@ -11,7 +11,7 @@
|
|||
<h2>Obtaining a token</h2>
|
||||
<p>All operations with the REST API have to be authenticated using a token.
|
||||
You can get this token either from Options -> ETAPI or programmatically
|
||||
using the <code>/auth/login</code> REST call (see the <a href="https://github.com/TriliumNext/Notes/blob/master/src/etapi/etapi.openapi.yaml">spec</a>).</p>
|
||||
using the <code>/auth/login</code> REST call (see the <a href="https://github.com/TriliumNext/Trilium/blob/master/src/etapi/etapi.openapi.yaml">spec</a>).</p>
|
||||
<h2>Authentication</h2>
|
||||
<h3>Via the <code>Authorization</code> header</h3><pre><code class="language-text-x-trilium-auto">GET https://myserver.com/etapi/app-info
|
||||
Authorization: ETAPITOKEN</code></pre>
|
||||
|
|
|
|||
|
|
@ -13,4 +13,4 @@
|
|||
<h2>Limitations</h2>
|
||||
<p>All resources (except for images) are created as note's attachments.</p>
|
||||
<p>HTML inside ENEX files is not exactly valid so some formatting maybe broken
|
||||
or lost. You can report major problems into <a href="https://github.com/TriliumNext/Notes/issues">Trilium issue tracker</a>.</p>
|
||||
or lost. You can report major problems into <a href="https://github.com/TriliumNext/Trilium/issues">Trilium issue tracker</a>.</p>
|
||||
|
|
@ -2,26 +2,27 @@
|
|||
<img style="aspect-ratio:991/403;" src="1_Jump to_image.png" width="991"
|
||||
height="403">
|
||||
</figure>
|
||||
|
||||
<h2>Jump to Note</h2>
|
||||
<p>The <em>Jump to Note</em> function allows easy navigation between notes
|
||||
by searching for their title. In addition to that, it can also trigger
|
||||
a full search or create notes.</p>
|
||||
<p>To enter the “Jump to” dialog:</p>
|
||||
<ul>
|
||||
<li data-list-item-id="e32758a67e793732cf0a2b23559bf47e2">In the <a class="reference-link" href="#root/_help_xYmIYSP6wE3F">Launch Bar</a>,
|
||||
<li>In the <a class="reference-link" href="#root/_help_xYmIYSP6wE3F">Launch Bar</a>,
|
||||
press
|
||||
<img src="2_Jump to_image.png">button.</li>
|
||||
<li data-list-item-id="ef176c16aa548f5b60f83fbd571f8b2db">Using the keyboard, press <kbd>Ctrl</kbd> + <kbd>J</kbd>.</li>
|
||||
<li>Using the keyboard, press <kbd>Ctrl</kbd> + <kbd>J</kbd>.</li>
|
||||
</ul>
|
||||
<p>In addition to searching for notes, it is also possible to search for
|
||||
commands. See the dedicated section below for more information.</p>
|
||||
<h3>Interaction</h3>
|
||||
<ul>
|
||||
<li data-list-item-id="e557396da361d4edc191507782cc3b0ec">By default, when there is no text entered it will display the most recent
|
||||
<li>By default, when there is no text entered it will display the most recent
|
||||
notes.</li>
|
||||
<li data-list-item-id="ead4c4587b1fcb9758a09696dc25da645">Using the keyboard, use the up or down arrow keys to navigate between
|
||||
<li>Using the keyboard, use the up or down arrow keys to navigate between
|
||||
items. Press <kbd>Enter</kbd> to open the desired note.</li>
|
||||
<li data-list-item-id="ed4a932ed462ca4a089abc4a268e21aad">If the note doesn't exist, it's possible to create it by typing the desired
|
||||
<li>If the note doesn't exist, it's possible to create it by typing the desired
|
||||
note title and selecting the <em>Create and link child note</em> option.</li>
|
||||
</ul>
|
||||
<h2>Recent notes</h2>
|
||||
|
|
@ -43,34 +44,32 @@
|
|||
<h3>Interaction</h3>
|
||||
<p>To trigger the command palette:</p>
|
||||
<ul>
|
||||
<li data-list-item-id="eace3b93758628f9dd7b554e6536d9e0f">Press <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>J</kbd> to display the command
|
||||
<li>Press <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>J</kbd> to display the command
|
||||
palette directly.</li>
|
||||
<li data-list-item-id="e848cc1df0264b1e4e766d6d35fd69336">If in the “Jump to” dialog, type <code>></code> in the search to switch
|
||||
<li>If in the “Jump to” dialog, type <code>></code> in the search to switch
|
||||
to the command palette.</li>
|
||||
</ul>
|
||||
<p>Interaction:</p>
|
||||
<ul>
|
||||
<li data-list-item-id="e53759821c15fdd85ec616172434c1bfe">Type a few words to filter between commands.</li>
|
||||
<li data-list-item-id="e344bd271c6fc35f48b1fed1137ac8725">Use the up and down arrows on the keyboard or the mouse to select a command.</li>
|
||||
<li
|
||||
data-list-item-id="ea66008550eb3c827f2880c85b68bf861">Press <kbd>Enter</kbd> to execute the command.</li>
|
||||
<li>Type a few words to filter between commands.</li>
|
||||
<li>Use the up and down arrows on the keyboard or the mouse to select a command.</li>
|
||||
<li>Press <kbd>Enter</kbd> to execute the command.</li>
|
||||
</ul>
|
||||
<p>To exit the command palette:</p>
|
||||
<ul>
|
||||
<li data-list-item-id="ea31cb4776c2e8b13b0a19eea437512fe">Remove the <code>></code> in the search to go back to the note search.</li>
|
||||
<li
|
||||
data-list-item-id="e6b92147aba5dc5b1e329ad22a3336703">Press <kbd>Esc</kbd> to dismiss the dialog entirely.</li>
|
||||
<li>Remove the <code>></code> in the search to go back to the note search.</li>
|
||||
<li>Press <kbd>Esc</kbd> to dismiss the dialog entirely.</li>
|
||||
</ul>
|
||||
<h3>Options available</h3>
|
||||
<p>Currently the following options are displayed:</p>
|
||||
<ul>
|
||||
<li data-list-item-id="eac227ab112677ff1f1900322df6d9ce9">Most of the <a class="reference-link" href="#root/pOsGYCXsbNQG/gh7bpGYxajRS/_help_A9Oc6YKKc65v">Keyboard Shortcuts</a> have
|
||||
<li>Most of the <a class="reference-link" href="#root/_help_A9Oc6YKKc65v">Keyboard Shortcuts</a> have
|
||||
an entry, with the exception of those that are too specific to be run from
|
||||
a dialog.</li>
|
||||
<li data-list-item-id="e3e1230fdeeb3101a2b1fb08d8d578f4b">Some additional options which are not yet available as keyboard shortcuts,
|
||||
<li>Some additional options which are not yet available as keyboard shortcuts,
|
||||
but can be accessed from various menus such as: exporting a note, showing
|
||||
attachments, searching for notes or configuring the <a class="reference-link"
|
||||
href="#root/pOsGYCXsbNQG/gh7bpGYxajRS/Vc8PjrjAGuOp/_help_xYmIYSP6wE3F">Launch Bar</a>.</li>
|
||||
href="#root/_help_xYmIYSP6wE3F">Launch Bar</a>.</li>
|
||||
</ul>
|
||||
<h3>Limitations</h3>
|
||||
<p>Currently it's not possible to define custom actions that are displayed
|
||||
|
|
|
|||
|
|
@ -120,5 +120,5 @@
|
|||
</table>
|
||||
<aside class="admonition tip">
|
||||
<p>If you would like to add your theme to this gallery, write a new post
|
||||
in <a href="https://github.com/TriliumNext/Notes/discussions/categories/show-and-tell">👐 Show and tell</a>.</p>
|
||||
in <a href="https://github.com/TriliumNext/Trilium/discussions/categories/show-and-tell">👐 Show and tell</a>.</p>
|
||||
</aside>
|
||||
|
|
@ -50,4 +50,4 @@
|
|||
noBackup=true</code></pre>
|
||||
<p>You can also review the <a href="#root/_help_Gzjqa934BdH4">configuration</a> file
|
||||
to provide all <code>config.ini</code> values as environment variables instead.</p>
|
||||
<p>See <a href="https://github.com/TriliumNext/Notes/blob/master/config-sample.ini">sample config</a>.</p>
|
||||
<p>See <a href="https://github.com/TriliumNext/Trilium/blob/master/config-sample.ini">sample config</a>.</p>
|
||||
|
|
@ -1,7 +1,7 @@
|
|||
<p>To install Trilium on your desktop, follow these steps:</p>
|
||||
<ol>
|
||||
<li><strong>Download the Latest Release</strong>: Obtain the appropriate binary
|
||||
release for your operating system from the <a href="https://github.com/TriliumNext/Notes/releases/latest">latest release page</a> on
|
||||
release for your operating system from the <a href="https://github.com/TriliumNext/Trilium/releases/latest">latest release page</a> on
|
||||
GitHub.</li>
|
||||
<li><strong>Extract the Package</strong>: Unzip the downloaded package to
|
||||
a location of your choice.</li>
|
||||
|
|
|
|||
|
|
@ -19,8 +19,8 @@
|
|||
its derivatives (like Ubuntu) below:</p><pre><code class="language-text-x-trilium-auto">sudo apt install libpng16-16 libpng-dev pkg-config autoconf libtool build-essential nasm libx11-dev libxkbfile-dev</code></pre>
|
||||
<h2>Installation</h2>
|
||||
<h3>Download</h3>
|
||||
<p>You can either download source code zip/tar from <a href="https://github.com/TriliumNext/Notes/releases/latest">https://github.com/TriliumNext/Notes/releases/latest</a>.</p>
|
||||
<p>For the latest version including betas, clone Git repository <strong>from</strong> <code>main</code> <strong>branch</strong> with:</p><pre><code class="language-text-x-trilium-auto">git clone -b main https://github.com/triliumnext/notes.git</code></pre>
|
||||
<p>You can either download source code zip/tar from <a href="https://github.com/TriliumNext/Trilium/releases/latest">https://github.com/TriliumNext/Trilium/releases/latest</a>.</p>
|
||||
<p>For the latest version including betas, clone Git repository <strong>from</strong> <code>main</code> <strong>branch</strong> with:</p><pre><code class="language-text-x-trilium-auto">git clone -b main https://github.com/triliumnext/trilium.git</code></pre>
|
||||
<h2>Installation</h2><pre><code class="language-text-x-trilium-auto">cd trilium
|
||||
|
||||
# download all node dependencies
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@
|
|||
<ul>
|
||||
<li>SSH into your server</li>
|
||||
<li>use <code>wget</code> (or <code>curl</code>) to download latest <code>TriliumNotes-Server-[VERSION]-linux-x64.tar.xz</code> (copy
|
||||
link from <a href="https://github.com/TriliumNext/Notes/releases">release page</a>,
|
||||
link from <a href="https://github.com/TriliumNext/Trilium/releases">release page</a>,
|
||||
notice <code>-Server</code> suffix) on your server.</li>
|
||||
<li>unpack the archive, e.g. using <code>tar -xf -d TriliumNotes-Server-[VERSION]-linux-x64.tar.xz</code>
|
||||
</li>
|
||||
|
|
|
|||
|
|
@ -2,8 +2,8 @@
|
|||
you want to use for your Trilium server.</p>
|
||||
<ol>
|
||||
<li>
|
||||
<p>Download docker image and create container</p><pre><code class="language-text-x-trilium-auto"> docker pull triliumnext/notes:[VERSION]
|
||||
docker create --name trilium -t -p 127.0.0.1:8080:8080 -v ~/trilium-data:/home/node/trilium-data triliumnext/notes:[VERSION]</code></pre>
|
||||
<p>Download docker image and create container</p><pre><code class="language-text-x-trilium-auto"> docker pull triliumnext/trilium:[VERSION]
|
||||
docker create --name trilium -t -p 127.0.0.1:8080:8080 -v ~/trilium-data:/home/node/trilium-data triliumnext/trilium:[VERSION]</code></pre>
|
||||
</li>
|
||||
<li>
|
||||
<p>Configure Apache proxy and websocket proxy</p>
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@
|
|||
<li><a href="#root/_help_rWX5eY045zbE"><strong>Docker Server Installation</strong></a>:
|
||||
Pull the new image and restart the container.</li>
|
||||
<li><strong>Other Installations</strong>: Download the latest version from
|
||||
the <a href="https://github.com/TriliumNext/Notes/releases/latest">release page</a> and
|
||||
the <a href="https://github.com/TriliumNext/Trilium/releases/latest">release page</a> and
|
||||
replace the existing application files.</li>
|
||||
</ul>
|
||||
<h2>Database Compatibility and Migration</h2>
|
||||
|
|
|
|||
2
apps/server/src/assets/doc_notes/en/User Guide/User Guide/Troubleshooting.html
generated
vendored
2
apps/server/src/assets/doc_notes/en/User Guide/User Guide/Troubleshooting.html
generated
vendored
|
|
@ -54,7 +54,7 @@ UPDATE options SET value = 'QpC8XoiYYeqHPtHKRtbNxfTHsk+pEBqVBODYp0FkPBa22tlBBKBM
|
|||
<h2>Reporting Bugs</h2>
|
||||
<p>Reporting bugs is highly valuable. Here are some tips:</p>
|
||||
<ul>
|
||||
<li>Use GitHub issues for reporting: <a href="https://github.com/TriliumNext/Notes/issues">https://github.com/TriliumNext/Notes/issues</a>
|
||||
<li>Use GitHub issues for reporting: <a href="https://github.com/TriliumNext/Trilium/issues">https://github.com/TriliumNext/Trilium/issues</a>
|
||||
</li>
|
||||
<li>Refer to the <a href="#root/_help_qzNzp9LYQyPT">error logs</a> page for
|
||||
information on providing necessary details.</li>
|
||||
|
|
|
|||
|
|
@ -32,7 +32,7 @@
|
|||
<p>If you don't feel comfortable attaching the logs or anything sensitive
|
||||
to the public GitHub issues, feel free to contact the devs in our Matrix
|
||||
<a
|
||||
href="https://github.com/TriliumNext/Notes#-discuss-with-us">support channel</a>.</p>
|
||||
href="https://github.com/TriliumNext/Trilium#-discuss-with-us">support channel</a>.</p>
|
||||
<p>Use this email to also provide anything which could assist in analysing
|
||||
the bug - e.g. files/images/ZIPs being imported or <a href="#root/_help_x59R8J8KV5Bp">anonymized database</a>.</p>
|
||||
<h3>Exporting note subtree for reproduction</h3>
|
||||
|
|
|
|||
|
|
@ -1,3 +1,3 @@
|
|||
<p>Go to <a href="https://github.com/TriliumNext/Notes/issues">Issues · TriliumNext/Notes</a> and
|
||||
<p>Go to <a href="https://github.com/TriliumNext/Trilium/issues">Issues · TriliumNext/Trilium</a> and
|
||||
press “New issue”.</p>
|
||||
<p>If you are reporting a bug, select “Bug Report” and fill in the details.</p>
|
||||
2
docs/Developer Guide/!!!meta.json
vendored
2
docs/Developer Guide/!!!meta.json
vendored
|
|
@ -1,6 +1,6 @@
|
|||
{
|
||||
"formatVersion": 2,
|
||||
"appVersion": "0.97.1",
|
||||
"appVersion": "0.97.2",
|
||||
"files": [
|
||||
{
|
||||
"isClone": false,
|
||||
|
|
|
|||
2
docs/Release Notes/!!!meta.json
vendored
2
docs/Release Notes/!!!meta.json
vendored
|
|
@ -1,6 +1,6 @@
|
|||
{
|
||||
"formatVersion": 2,
|
||||
"appVersion": "0.97.1",
|
||||
"appVersion": "0.97.2",
|
||||
"files": [
|
||||
{
|
||||
"isClone": false,
|
||||
|
|
|
|||
18
docs/User Guide/!!!meta.json
vendored
18
docs/User Guide/!!!meta.json
vendored
|
|
@ -1,6 +1,6 @@
|
|||
{
|
||||
"formatVersion": 2,
|
||||
"appVersion": "0.97.1",
|
||||
"appVersion": "0.97.2",
|
||||
"files": [
|
||||
{
|
||||
"isClone": false,
|
||||
|
|
@ -3794,23 +3794,23 @@
|
|||
{
|
||||
"type": "relation",
|
||||
"name": "internalLink",
|
||||
"value": "xYmIYSP6wE3F",
|
||||
"value": "A9Oc6YKKc65v",
|
||||
"isInheritable": false,
|
||||
"position": 10
|
||||
},
|
||||
{
|
||||
"type": "relation",
|
||||
"name": "internalLink",
|
||||
"value": "xYmIYSP6wE3F",
|
||||
"isInheritable": false,
|
||||
"position": 20
|
||||
},
|
||||
{
|
||||
"type": "label",
|
||||
"name": "iconClass",
|
||||
"value": "bx bx-send",
|
||||
"isInheritable": false,
|
||||
"position": 10
|
||||
},
|
||||
{
|
||||
"type": "relation",
|
||||
"name": "internalLink",
|
||||
"value": "A9Oc6YKKc65v",
|
||||
"isInheritable": false,
|
||||
"position": 20
|
||||
}
|
||||
],
|
||||
"format": "markdown",
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue