mirror of
https://github.com/zadam/trilium.git
synced 2025-10-20 23:29:02 +02:00
feat(docs): remove inline warnings and apply admonitions
This commit is contained in:
Elian Doran
parent
c27f13d49f
commit
ac419e8ab4
@ -9,7 +9,7 @@
|
||||
"pOsGYCXsbNQG"
|
||||
],
|
||||
"title": "User Guide",
|
||||
"notePosition": 90,
|
||||
"notePosition": 10,
|
||||
"prefix": null,
|
||||
"isExpanded": false,
|
||||
"type": "text",
|
||||
@ -1481,13 +1481,6 @@
|
||||
"type": "text",
|
||||
"mime": "text/markdown",
|
||||
"attributes": [
|
||||
{
|
||||
"type": "relation",
|
||||
"name": "imageLink",
|
||||
"value": "JXFeNgU8Xnp1",
|
||||
"isInheritable": false,
|
||||
"position": 10
|
||||
},
|
||||
{
|
||||
"type": "relation",
|
||||
"name": "internalLink",
|
||||
@ -1516,13 +1509,6 @@
|
||||
"isInheritable": false,
|
||||
"position": 50
|
||||
},
|
||||
{
|
||||
"type": "relation",
|
||||
"name": "internalLink",
|
||||
"value": "BFs8mudNFgCS",
|
||||
"isInheritable": false,
|
||||
"position": 60
|
||||
},
|
||||
{
|
||||
"type": "label",
|
||||
"name": "shareAlias",
|
||||
@ -1648,13 +1634,6 @@
|
||||
"isInheritable": false,
|
||||
"position": 40
|
||||
},
|
||||
{
|
||||
"type": "relation",
|
||||
"name": "internalLink",
|
||||
"value": "_lbSettings",
|
||||
"isInheritable": false,
|
||||
"position": 50
|
||||
},
|
||||
{
|
||||
"type": "label",
|
||||
"name": "iconClass",
|
||||
@ -6553,6 +6532,13 @@
|
||||
"value": "bx bx-question-mark",
|
||||
"isInheritable": false,
|
||||
"position": 40
|
||||
},
|
||||
{
|
||||
"type": "relation",
|
||||
"name": "internalLink",
|
||||
"value": "wy8So3yZZlH9",
|
||||
"isInheritable": false,
|
||||
"position": 80
|
||||
}
|
||||
],
|
||||
"format": "markdown",
|
||||
|
||||
@ -15,4 +15,4 @@ After importing the ENEX file, go over the imported notes and resources to be su
|
||||
|
||||
All resources (except for images) are created as note's attachments.
|
||||
|
||||
HTML inside ENEX files is not exactly valid so some formatting maybe broken or lost. You can report major problems into [Trilium issue tracker](https://github.com/TriliumNext/Notes/issues). %%{WARNING}%%
|
||||
HTML inside ENEX files is not exactly valid so some formatting maybe broken or lost. You can report major problems into [Trilium issue tracker](https://github.com/TriliumNext/Notes/issues).
|
||||
@ -1,23 +1,17 @@
|
||||
# FAQ
|
||||
## Mac OS support
|
||||
## macOS support
|
||||
|
||||
Originally, desktop builds of Trilium Notes has been available for Windows & Linux, but there has been a considerable demand for macOS build.
|
||||
Originally, Trilium Notes considered the macOS build unsupported. TriliumNext commits to make the experience on macOS as good as possible.
|
||||
|
||||
So I made one, but I underestimated the differences and specifics of Mac platform which seems to require special handling in several places. My lack of knowledge and frankly willingness to learn & code Mac specific functionality resulted in a current state where [Trilium does not integrate well into the OS](https://github.com/TriliumNext/Notes/issues/511)
|
||||
if you find any platform-specific issues, feel free to [report them](Troubleshooting/Reporting%20issues.md).
|
||||
|
||||
%%{WARNING}%%.
|
||||
## Translation / localisation support
|
||||
|
||||
macOS build is from now on considered "unsupported". I will strive to keep it fundamentally functional, but I won't work on Mac specific features or integrations. Note that this is more of an acknowledgment of an existing state rather than sudden change of direction.
|
||||
The original Trilium Notes application did not support multiple languages. Since we believe that internationalisation is a core part of an application, we have added support for it.
|
||||
|
||||
Of course, PRs are welcome.
|
||||
Contributions to translations are welcome.
|
||||
|
||||
## Translation / localization support
|
||||
|
||||
Trilium is currently available only in English. Translation to other languages is not planned in the near/medium term because it brings a significant maintenance overhead. This decision might be revisited once Trilium stabilizes into a more mature product.
|
||||
|
||||
For Chinese, there's an unofficial fork [here](https://github.com/Nriver/trilium-translation). Use at your own risk.
|
||||
|
||||
## Multi user support
|
||||
## Multi-user support
|
||||
|
||||
Common request is to allow multiple users collaborate, share notes etc. So far I'm resisting this because of these reasons:
|
||||
|
||||
@ -41,7 +35,9 @@ No.
|
||||
|
||||
These general purpose sync apps are not suitable to sync database files which are open and being worked on by another application. The result is that they will corrupt the database file, resulting in data loss and this message in the Trilium logs:
|
||||
|
||||
> SqliteError: database disk image is malformed
|
||||
```
|
||||
SqliteError: database disk image is malformed
|
||||
```
|
||||
|
||||
The only supported way to sync Trilium's data across the network is to use a [sync/web server](Installation%20%26%20Setup/Synchronization.md).
|
||||
|
||||
|
||||
@ -18,7 +18,7 @@ Let's assume you want to restore the weekly backup, here's how to do it:
|
||||
|
||||
* find [data directory](Data%20directory.md) Trilium uses - easy way is to open "About Trilium Notes" from "Menu" in upper left corner and looking at "data directory"
|
||||
* I'll refer to `~/trilium-data` as data directory from now on
|
||||
* find `~/trilium-data/backup/backup-weekly.db` - this is the [document](#root/xjSsCcvVZf6H)backup
|
||||
* find `~/trilium-data/backup/backup-weekly.db` - this is the [document](#root/xjSsCcvVZf6H) backup
|
||||
* at this point stop/kill Trilium
|
||||
* delete `~/trilium-data/document.db`, `~/trilium-data/document.db-wal` and `~/trilium-data/document.db-shm` (latter two files are auto generated)
|
||||
* copy and rename this `~/trilium-data/backup/backup-weekly.db` to `~/trilium-data/document.db`
|
||||
@ -40,4 +40,4 @@ noBackup=true
|
||||
|
||||
You can also review the [configuration](../Advanced%20Usage/Configuration%20\(config.ini%20or%20e.md) file to provide all `config.ini` values as environment variables instead.
|
||||
|
||||
See [sample config](https://github.com/TriliumNext/Notes/blob/master/config-sample.ini). %%{WARNING}%%
|
||||
See [sample config](https://github.com/TriliumNext/Notes/blob/master/config-sample.ini).
|
||||
@ -9,7 +9,8 @@ If you need help installing Docker, reference the [Docker Installation Docs](htt
|
||||
|
||||
**Note:** Trilium's Docker container requires root privileges to operate correctly.
|
||||
|
||||
> \[!WARNING\] If you're using a SMB/CIFS share or folder as your Trilium data directory, [you'll need](https://github.com/TriliumNext/Notes/issues/415#issuecomment-2344824400) to add the mount options of `nobrl` and `noperm` when mounting your SMB share.
|
||||
> [!WARNING]
|
||||
> If you're using a SMB/CIFS share or folder as your Trilium data directory, [you'll need](https://github.com/TriliumNext/Notes/issues/415#issuecomment-2344824400) to add the mount options of `nobrl` and `noperm` when mounting your SMB share.
|
||||
|
||||
## Running with Docker Compose
|
||||
|
||||
|
||||
@ -5,7 +5,7 @@ The recommended way is to use a Helm chart.
|
||||
|
||||
## Root privileges
|
||||
|
||||
> \[!NOTE\]
|
||||
> [!NOTE]
|
||||
> The Trilium container at this time needs to be run with root privileges. It will swap to UID and GID `1000:1000` to run the `node` process after execution though, so the main process doesn't run with root privileges.
|
||||
|
||||
The Trilium docker container needs to be run with root privileges. The node process inside the container will be started with reduced privileges (uid:gid 1000:1000) after some initialization logic. Please make sure that you don't use a security context (PodSecurityContext) which changes the user ID. To use a different uid:gid for file storage and the application, please use the `USER_UID` & `USER_GID` environment variables.
|
||||
|
||||
@ -25,10 +25,12 @@ sudo apt install libpng16-16 libpng-dev pkg-config autoconf libtool build-essent
|
||||
|
||||
### Download
|
||||
|
||||
You can either download source code zip/tar from [https://github.com/TriliumNext/Notes/releases/latest\]\]](https://github.com/TriliumNext/Notes/releases/latest%5D%5D) %%{WARNING}%%or clone git repository **from stable branch** with
|
||||
You can either download source code zip/tar from [https://github.com/TriliumNext/Notes/releases/latest](https://github.com/TriliumNext/Notes/releases/latest).
|
||||
|
||||
For the latest version including betas, clone Git repository **from** `**master**` **branch** with:
|
||||
|
||||
```
|
||||
git clone -b stable https://github.com/triliumnext/notes.git %%{WARNING}%%
|
||||
git clone -b master https://github.com/triliumnext/notes.git
|
||||
```
|
||||
|
||||
## Installation
|
||||
|
||||
@ -3,9 +3,9 @@ This is essentially Trilium sources + node modules + node.js runtime packaged in
|
||||
|
||||
## Steps
|
||||
|
||||
* ssh into your server
|
||||
* use `wget` (or `curl` or whatever) to download latest [trilium-linux-x64-server-\[VERSION\].xz](https://github.com/TriliumNext/Notes/releases/latest)%%{WARNING}%% (notice -server suffix) on your server
|
||||
* unpack the archive, e.g. using `tar -xf -d trilium-linux-x64-server-[VERSION].tar.xz`
|
||||
* SSH into your server
|
||||
* use `wget` (or `curl`) to download latest `TriliumNextNotes-Server-[VERSION]-linux-x64.tar.xz` (notice `-Server` suffix) on your server.
|
||||
* unpack the archive, e.g. using `tar -xf -d TriliumNextNotes-Server-[VERSION]-linux-x64.tar.xz`
|
||||
* `cd trilium-linux-x64-server`
|
||||
* `./trilium.sh`
|
||||
* you can open the browser and open http://\[your-server-hostname\]:8080 and you should see Trilium initialization page
|
||||
@ -20,7 +20,7 @@ The problem with above steps is that once you close the SSH connection, the Tril
|
||||
* After downloading, extract and move Trilium:
|
||||
|
||||
```
|
||||
tar -xvf trilium-linux-x64-server-[VERSION].tar.xz
|
||||
tar -xvf TriliumNextNotes-Server-[VERSION]-linux-x64.tar.xz
|
||||
sudo mv trilium-linux-x64-server /opt/trilium
|
||||
```
|
||||
|
||||
|
||||
@ -24,7 +24,7 @@ If there's multiple clippings from the same page (and on the same day), then the
|
||||
**Extension is available from:**
|
||||
|
||||
* [Project release page](https://github.com/TriliumNext/web-clipper/releases) - .xpi for Firefox and .zip for Chromium based browsers.
|
||||
* %%{WARNING}%% [Chrome Web Store](https://chromewebstore.google.com/detail/trilium-web-clipper/dfhgmnfclbebfobmblelddiejjcijbjm)
|
||||
* [Chrome Web Store](https://chromewebstore.google.com/detail/trilium-web-clipper/dfhgmnfclbebfobmblelddiejjcijbjm)
|
||||
|
||||
## Configuration
|
||||
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
# Content language & Right-to-left support
|
||||
|
||||
|
||||
|
||||
A language hint can be provided for text notes. This option informs the browser or the desktop application about the language the note is written in (for example this might help with spellchecking), and it also determines whether the text is displayed from right-to-left for languages such as Arabic, Hebrew, etc.
|
||||
|
||||
|
||||
@ -9,16 +9,11 @@
|
||||
|
||||
1. [Server installation](Installation%20%26%20Setup/Server%20Installation.md)
|
||||
2. [Mobile frontend](Installation%20%26%20Setup/Mobile%20Frontend.md) (optional)
|
||||
3. [](https://heroku.com/deploy?template=https://github.com/feilongfl/trilium-heroku) %%{WARNING}%%
|
||||
4. [PikaPods managed hosting](https://www.pikapods.com/pods?run=trilium-next)
|
||||
3. [PikaPods managed hosting](https://www.pikapods.com/pods?run=trilium-next)
|
||||
|
||||
**Combination of server and desktop/laptop** - Install the application on both a server, for web access and data synchronization, and desktop instance(s). This allows all the data to be stored on the server and either accessed from the web browser, or the desktop application. The desktop application will sync and store the data locally so that it can be used when offline.
|
||||
**Combination of server and desktop/laptop** - Install the application on both a server, for web access and data synchronisation, and desktop instance(s). This allows all the data to be stored on the server and either accessed from the web browser, or the desktop application. The desktop application will sync and store the data locally so that it can be used when offline.
|
||||
|
||||
1. [Server installation](Installation%20%26%20Setup/Server%20Installation.md)
|
||||
2. [Mobile frontend](Installation%20%26%20Setup/Mobile%20Frontend.md) (optional)
|
||||
3. [Desktop installation](Installation%20%26%20Setup/Desktop%20Installation.md)
|
||||
4. [Synchronization](Installation%20%26%20Setup/Synchronization.md)
|
||||
|
||||
## Basic concepts
|
||||
|
||||
1. Understand [Note](Basic%20Concepts/Note.md)
|
||||
4. [Synchronization](Installation%20%26%20Setup/Synchronization.md)
|
||||
42
src/public/app/doc_notes/en/User Guide/!!!meta.json
generated
42
src/public/app/doc_notes/en/User Guide/!!!meta.json
generated
@ -9,9 +9,9 @@
|
||||
"pOsGYCXsbNQG"
|
||||
],
|
||||
"title": "User Guide",
|
||||
"notePosition": 110,
|
||||
"notePosition": 10,
|
||||
"prefix": null,
|
||||
"isExpanded": false,
|
||||
"isExpanded": true,
|
||||
"type": "text",
|
||||
"mime": "text/html",
|
||||
"attributes": [],
|
||||
@ -1481,13 +1481,6 @@
|
||||
"type": "text",
|
||||
"mime": "text/markdown",
|
||||
"attributes": [
|
||||
{
|
||||
"type": "relation",
|
||||
"name": "imageLink",
|
||||
"value": "JXFeNgU8Xnp1",
|
||||
"isInheritable": false,
|
||||
"position": 10
|
||||
},
|
||||
{
|
||||
"type": "relation",
|
||||
"name": "internalLink",
|
||||
@ -1516,13 +1509,6 @@
|
||||
"isInheritable": false,
|
||||
"position": 50
|
||||
},
|
||||
{
|
||||
"type": "relation",
|
||||
"name": "internalLink",
|
||||
"value": "BFs8mudNFgCS",
|
||||
"isInheritable": false,
|
||||
"position": 60
|
||||
},
|
||||
{
|
||||
"type": "label",
|
||||
"name": "shareAlias",
|
||||
@ -1552,7 +1538,7 @@
|
||||
"title": "Basic Concepts",
|
||||
"notePosition": 60,
|
||||
"prefix": null,
|
||||
"isExpanded": false,
|
||||
"isExpanded": true,
|
||||
"type": "text",
|
||||
"mime": "text/html",
|
||||
"attributes": [
|
||||
@ -1648,13 +1634,6 @@
|
||||
"isInheritable": false,
|
||||
"position": 40
|
||||
},
|
||||
{
|
||||
"type": "relation",
|
||||
"name": "internalLink",
|
||||
"value": "_lbSettings",
|
||||
"isInheritable": false,
|
||||
"position": 50
|
||||
},
|
||||
{
|
||||
"type": "label",
|
||||
"name": "iconClass",
|
||||
@ -3073,7 +3052,7 @@
|
||||
"title": "Import & Export",
|
||||
"notePosition": 90,
|
||||
"prefix": null,
|
||||
"isExpanded": false,
|
||||
"isExpanded": true,
|
||||
"type": "text",
|
||||
"mime": "text/html",
|
||||
"attributes": [],
|
||||
@ -5554,7 +5533,7 @@
|
||||
"title": "Installation & Setup",
|
||||
"notePosition": 160,
|
||||
"prefix": null,
|
||||
"isExpanded": false,
|
||||
"isExpanded": true,
|
||||
"type": "text",
|
||||
"mime": "text/html",
|
||||
"attributes": [
|
||||
@ -5629,7 +5608,7 @@
|
||||
"title": "Server Installation",
|
||||
"notePosition": 20,
|
||||
"prefix": null,
|
||||
"isExpanded": false,
|
||||
"isExpanded": true,
|
||||
"type": "text",
|
||||
"mime": "text/markdown",
|
||||
"attributes": [
|
||||
@ -5742,7 +5721,7 @@
|
||||
"title": "1. Installing the server",
|
||||
"notePosition": 10,
|
||||
"prefix": null,
|
||||
"isExpanded": false,
|
||||
"isExpanded": true,
|
||||
"type": "text",
|
||||
"mime": "text/html",
|
||||
"attributes": [],
|
||||
@ -6553,6 +6532,13 @@
|
||||
"value": "bx bx-question-mark",
|
||||
"isInheritable": false,
|
||||
"position": 40
|
||||
},
|
||||
{
|
||||
"type": "relation",
|
||||
"name": "internalLink",
|
||||
"value": "wy8So3yZZlH9",
|
||||
"isInheritable": false,
|
||||
"position": 80
|
||||
}
|
||||
],
|
||||
"format": "html",
|
||||
|
||||
@ -28,8 +28,7 @@
|
||||
<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>.
|
||||
%%{WARNING}%%</p>
|
||||
or lost. You can report major problems into <a href="https://github.com/TriliumNext/Notes/issues">Trilium issue tracker</a>.</p>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
|
||||
@ -13,27 +13,16 @@
|
||||
<h1 data-trilium-h1>FAQ</h1>
|
||||
|
||||
<div class="ck-content">
|
||||
<h2>Mac OS support</h2>
|
||||
<p>Originally, desktop builds of Trilium Notes has been available for Windows
|
||||
& Linux, but there has been a considerable demand for macOS build.</p>
|
||||
<p>So I made one, but I underestimated the differences and specifics of Mac
|
||||
platform which seems to require special handling in several places. My
|
||||
lack of knowledge and frankly willingness to learn & code Mac specific
|
||||
functionality resulted in a current state where <a href="https://github.com/TriliumNext/Notes/issues/511">Trilium does not integrate well into the OS</a> </p>
|
||||
<p>%%{WARNING}%%.</p>
|
||||
<p>macOS build is from now on considered "unsupported". I will strive to
|
||||
keep it fundamentally functional, but I won't work on Mac specific features
|
||||
or integrations. Note that this is more of an acknowledgment of an existing
|
||||
state rather than sudden change of direction.</p>
|
||||
<p>Of course, PRs are welcome.</p>
|
||||
<h2>Translation / localization support</h2>
|
||||
<p>Trilium is currently available only in English. Translation to other languages
|
||||
is not planned in the near/medium term because it brings a significant
|
||||
maintenance overhead. This decision might be revisited once Trilium stabilizes
|
||||
into a more mature product.</p>
|
||||
<p>For Chinese, there's an unofficial fork <a href="https://github.com/Nriver/trilium-translation">here</a>.
|
||||
Use at your own risk.</p>
|
||||
<h2>Multi user support</h2>
|
||||
<h2>macOS support</h2>
|
||||
<p>Originally, Trilium Notes considered the macOS build unsupported. TriliumNext
|
||||
commits to make the experience on macOS as good as possible.</p>
|
||||
<p>if you find any platform-specific issues, feel free to <a href="Troubleshooting/Reporting%20issues.html">report them</a>.</p>
|
||||
<h2>Translation / localisation support</h2>
|
||||
<p>The original Trilium Notes application did not support multiple languages.
|
||||
Since we believe that internationalisation is a core part of an application,
|
||||
we have added support for it.</p>
|
||||
<p>Contributions to translations are welcome.</p>
|
||||
<h2>Multi-user support</h2>
|
||||
<p>Common request is to allow multiple users collaborate, share notes etc.
|
||||
So far I'm resisting this because of these reasons:</p>
|
||||
<ul>
|
||||
@ -68,10 +57,7 @@
|
||||
<p>These general purpose sync apps are not suitable to sync database files
|
||||
which are open and being worked on by another application. The result is
|
||||
that they will corrupt the database file, resulting in data loss and this
|
||||
message in the Trilium logs:</p>
|
||||
<blockquote>
|
||||
<p>SqliteError: database disk image is malformed</p>
|
||||
</blockquote>
|
||||
message in the Trilium logs:</p><pre><code class="language-text-x-trilium-auto">SqliteError: database disk image is malformed</code></pre>
|
||||
<p>The only supported way to sync Trilium's data across the network is to
|
||||
use a <a href="Installation%20%26%20Setup/Synchronization.html">sync/web server</a>.</p>
|
||||
<h2>Why database instead of flat files?</h2>
|
||||
|
||||
@ -63,8 +63,7 @@
|
||||
noBackup=true</code></pre>
|
||||
<p>You can also review the <a href="../Advanced%20Usage/Configuration%20(config.ini%20or%20e.html">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>.
|
||||
%%{WARNING}%%</p>
|
||||
<p>See <a href="https://github.com/TriliumNext/Notes/blob/master/config-sample.ini">sample config</a>.</p>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
|
||||
@ -23,12 +23,12 @@
|
||||
</p>
|
||||
<p><strong>Note:</strong> Trilium's Docker container requires root privileges
|
||||
to operate correctly.</p>
|
||||
<blockquote>
|
||||
<p>[!WARNING] If you're using a SMB/CIFS share or folder as your Trilium
|
||||
data directory, <a href="https://github.com/TriliumNext/Notes/issues/415#issuecomment-2344824400">you'll need</a> to
|
||||
add the mount options of <code>nobrl</code> and <code>noperm</code> when mounting
|
||||
your SMB share.</p>
|
||||
</blockquote>
|
||||
<aside class="admonition warning">
|
||||
<p>If you're using a SMB/CIFS share or folder as your Trilium data directory,
|
||||
<a
|
||||
href="https://github.com/TriliumNext/Notes/issues/415#issuecomment-2344824400">you'll need</a>to add the mount options of <code>nobrl</code> and <code>noperm</code> when
|
||||
mounting your SMB share.</p>
|
||||
</aside>
|
||||
<h2>Running with Docker Compose</h2>
|
||||
<h3>Grab the latest docker-compose.yml:</h3><pre><code class="language-text-x-trilium-auto">wget https://raw.githubusercontent.com/TriliumNext/Notes/master/docker-compose.yml</code></pre>
|
||||
<p>Optionally, edit the <code>docker-compose.yml</code> file to configure the
|
||||
|
||||
@ -18,12 +18,11 @@
|
||||
own Kubernetes deployment.</p>
|
||||
<p>The recommended way is to use a Helm chart.</p>
|
||||
<h2>Root privileges</h2>
|
||||
<blockquote>
|
||||
<p>[!NOTE]
|
||||
<br>The Trilium container at this time needs to be run with root privileges.
|
||||
<aside class="admonition note">
|
||||
<p>The Trilium container at this time needs to be run with root privileges.
|
||||
It will swap to UID and GID <code>1000:1000</code> to run the <code>node</code> process
|
||||
after execution though, so the main process doesn't run with root privileges.</p>
|
||||
</blockquote>
|
||||
</aside>
|
||||
<p>The Trilium docker container needs to be run with root privileges. The
|
||||
node process inside the container will be started with reduced privileges
|
||||
(uid:gid 1000:1000) after some initialization logic. Please make sure that
|
||||
|
||||
@ -29,8 +29,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%5D%5D">https://github.com/TriliumNext/Notes/releases/latest]]</a> %%{WARNING}%%or
|
||||
clone git repository <strong>from stable branch</strong> with</p><pre><code class="language-text-x-trilium-auto">git clone -b stable https://github.com/triliumnext/notes.git %%{WARNING}%%</code></pre>
|
||||
<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><strong>master</strong></code><strong> branch</strong> with:</p><pre><code class="language-text-x-trilium-auto">git clone -b master https://github.com/triliumnext/notes.git</code></pre>
|
||||
<h2>Installation</h2><pre><code class="language-text-x-trilium-auto">cd trilium
|
||||
|
||||
# download all node dependencies
|
||||
|
||||
@ -17,12 +17,10 @@
|
||||
into one 7z file.</p>
|
||||
<h2>Steps</h2>
|
||||
<ul>
|
||||
<li>ssh into your server</li>
|
||||
<li>use <code>wget</code> (or <code>curl</code> or whatever) to download latest
|
||||
<a
|
||||
href="https://github.com/TriliumNext/Notes/releases/latest">trilium-linux-x64-server-[VERSION].xz</a>%%{WARNING}%% (notice -server
|
||||
suffix) on your server</li>
|
||||
<li>unpack the archive, e.g. using <code>tar -xf -d trilium-linux-x64-server-[VERSION].tar.xz</code>
|
||||
<li>SSH into your server</li>
|
||||
<li>use <code>wget</code> (or <code>curl</code>) to download latest <code>TriliumNextNotes-Server-[VERSION]-linux-x64.tar.xz</code> (notice <code>-Server</code> suffix)
|
||||
on your server.</li>
|
||||
<li>unpack the archive, e.g. using <code>tar -xf -d TriliumNextNotes-Server-[VERSION]-linux-x64.tar.xz</code>
|
||||
</li>
|
||||
<li><code>cd trilium-linux-x64-server</code>
|
||||
</li>
|
||||
@ -41,7 +39,7 @@
|
||||
<h2>Configure Trilium to auto-run on boot with systemd</h2>
|
||||
<ul>
|
||||
<li>After downloading, extract and move Trilium:</li>
|
||||
</ul><pre><code class="language-text-x-trilium-auto">tar -xvf trilium-linux-x64-server-[VERSION].tar.xz
|
||||
</ul><pre><code class="language-text-x-trilium-auto">tar -xvf TriliumNextNotes-Server-[VERSION]-linux-x64.tar.xz
|
||||
sudo mv trilium-linux-x64-server /opt/trilium</code></pre>
|
||||
<ul>
|
||||
<li>Create the service:</li>
|
||||
|
||||
@ -42,7 +42,7 @@
|
||||
<ul>
|
||||
<li><a href="https://github.com/TriliumNext/web-clipper/releases">Project release page</a> -
|
||||
.xpi for Firefox and .zip for Chromium based browsers.</li>
|
||||
<li>%%{WARNING}%% <a href="https://chromewebstore.google.com/detail/trilium-web-clipper/dfhgmnfclbebfobmblelddiejjcijbjm">Chrome Web Store</a>
|
||||
<li><a href="https://chromewebstore.google.com/detail/trilium-web-clipper/dfhgmnfclbebfobmblelddiejjcijbjm">Chrome Web Store</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h2>Configuration</h2>
|
||||
|
||||
@ -14,7 +14,7 @@
|
||||
|
||||
<div class="ck-content">
|
||||
<p>
|
||||
<img src="api/images/ZOupAe21YiqT/Content language & Right-t.png"
|
||||
<img src="api/images/4yHAD34xyvAl/Content language & Right-t.png"
|
||||
alt="">
|
||||
</p>
|
||||
<p>A language hint can be provided for text notes. This option informs the
|
||||
|
||||
@ -27,12 +27,11 @@
|
||||
<li><a href="Installation%20%26%20Setup/Server%20Installation.html">Server installation</a>
|
||||
</li>
|
||||
<li><a href="Installation%20%26%20Setup/Mobile%20Frontend.html">Mobile frontend</a> (optional)</li>
|
||||
<li><a href="https://heroku.com/deploy?template=https://github.com/feilongfl/trilium-heroku"><img src="Attachments/home-button.svg" alt="Deploy"></a>%%{WARNING}%%</li>
|
||||
<li><a href="https://www.pikapods.com/pods?run=trilium-next">PikaPods managed hosting</a>
|
||||
</li>
|
||||
</ol>
|
||||
<p><strong>Combination of server and desktop/laptop</strong> - Install the
|
||||
application on both a server, for web access and data synchronization,
|
||||
application on both a server, for web access and data synchronisation,
|
||||
and desktop instance(s). This allows all the data to be stored on the server
|
||||
and either accessed from the web browser, or the desktop application. The
|
||||
desktop application will sync and store the data locally so that it can
|
||||
@ -46,11 +45,6 @@
|
||||
<li><a href="Installation%20%26%20Setup/Synchronization.html">Synchronization</a>
|
||||
</li>
|
||||
</ol>
|
||||
<h2>Basic concepts</h2>
|
||||
<ol>
|
||||
<li>Understand <a href="Basic%20Concepts/Note.html">Note</a>
|
||||
</li>
|
||||
</ol>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
|
||||
26
src/public/app/doc_notes/en/User Guide/style.css
generated
26
src/public/app/doc_notes/en/User Guide/style.css
generated
@ -17,6 +17,32 @@
|
||||
margin: 0 !important;
|
||||
}
|
||||
|
||||
.ck-content .admonition {
|
||||
--accent-color: var(--card-border-color);
|
||||
border: 1px solid var(--accent-color);
|
||||
box-shadow: var(--card-box-shadow);
|
||||
background: var(--card-background-color);
|
||||
border-radius: 0.5em;
|
||||
padding: 1em;
|
||||
margin: 1.25em 0;
|
||||
margin-right: 14px;
|
||||
position: relative;
|
||||
}
|
||||
|
||||
.ck-content .admonition p:last-child {
|
||||
margin-bottom: 0;
|
||||
}
|
||||
|
||||
.ck-content .admonition p, h2 {
|
||||
margin-top: 0;
|
||||
}
|
||||
|
||||
.ck-content .admonition.note { --accent-color: #69c7ff; }
|
||||
.ck-content .admonition.tip { --accent-color: #40c025; }
|
||||
.ck-content .admonition.important { --accent-color: #9839f7; }
|
||||
.ck-content .admonition.caution { --accent-color: #ff2e2e; }
|
||||
.ck-content .admonition.warning { --accent-color: #e2aa03; }
|
||||
|
||||
/*
|
||||
* CKEditor 5 (v41.0.0) content styles.
|
||||
* Generated on Fri, 26 Jan 2024 10:23:49 GMT.
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user