Merge remote-tracking branch 'origin/main' into standalone

This commit is contained in:
Elian Doran
2026-04-19 20:26:10 +03:00
365 changed files with 16768 additions and 5610 deletions

View File

@@ -1,5 +1,5 @@
# Documentation
There are multiple types of documentation for Trilium:<img class="image-style-align-right" src="api/images/sXF9YQCkQPQv/Documentation_image.png" width="205" height="162">
There are multiple types of documentation for Trilium:<img class="image-style-align-right" src="api/images/HWpeC3cnbb1K/Documentation_image.png" width="205" height="162">
* The _User Guide_ represents the user-facing documentation. This documentation can be browsed by users directly from within Trilium, by pressing <kbd>F1</kbd>.
* The _Developer's Guide_ represents a set of Markdown documents that present the internals of Trilium, for developers.

28
docs/README-ca.md vendored
View File

@@ -35,27 +35,27 @@ personal.
<img src="./app.png" alt="Trilium Screenshot" width="1000">
## ⏬ Download
- [Latest release](https://github.com/TriliumNext/Trilium/releases/latest)
stable version, recommended for most users.
## ⏬ Descarrega
- [Última versió](https://github.com/TriliumNext/Trilium/releases/latest)
versió estable, recomanada per a la majoria d'usuaris.
- [Nightly build](https://github.com/TriliumNext/Trilium/releases/tag/nightly)
unstable development version, updated daily with the latest features and
fixes.
## 📚 Documentation
## 📚 Documentació
**Visit our comprehensive documentation at
**Visiteu la nostra documentació completa a
[docs.triliumnotes.org](https://docs.triliumnotes.org/)**
Our documentation is available in multiple formats:
- **Online Documentation**: Browse the full documentation at
La nostra documentació està disponible en diversos formats:
- **Documentació en línia**: Consulteu la documentació completa a
[docs.triliumnotes.org](https://docs.triliumnotes.org/)
- **In-App Help**: Press `F1` within Trilium to access the same documentation
directly in the application
- **GitHub**: Navigate through the [User Guide](./User%20Guide/User%20Guide/) in
this repository
- **Ajuda a l'aplicació**: Premeu `F1` dins de Trilium per accedir directament a
la documentació a l'aplicació.
- **GitHub**: Navega per la [Guia d'usuari](./User%20Guide/User%20Guide/)
d'aquest repositori
### Quick Links
### Enllaços ràpids
- [Getting Started Guide](https://docs.triliumnotes.org/)
- [Installation Instructions](https://docs.triliumnotes.org/user-guide/setup)
- [Docker
@@ -88,8 +88,8 @@ Our documentation is available in multiple formats:
[attributes](https://docs.triliumnotes.org/user-guide/advanced-usage/attributes)
can be used for note organization, querying and advanced
[scripting](https://docs.triliumnotes.org/user-guide/scripts)
* UI available in English, German, Spanish, French, Romanian, and Chinese
(simplified and traditional)
* Interfície disponible en anglès, alemany, espanyol, francès, romanès i xinès
(simplificat i tradicional)
* Direct [OpenID and TOTP
integration](https://docs.triliumnotes.org/user-guide/setup/server/mfa) for
more secure login

12
docs/README-en_GB.md vendored
View File

@@ -85,14 +85,14 @@ Our documentation is available in multiple formats:
versioning](https://docs.triliumnotes.org/user-guide/concepts/notes/note-revisions)
* Note
[attributes](https://docs.triliumnotes.org/user-guide/advanced-usage/attributes)
can be used for note organization, querying and advanced
can be used for note organisation, querying and advanced
[scripting](https://docs.triliumnotes.org/user-guide/scripts)
* UI available in English, German, Spanish, French, Romanian, and Chinese
(simplified and traditional)
* Direct [OpenID and TOTP
integration](https://docs.triliumnotes.org/user-guide/setup/server/mfa) for
more secure login
* [Synchronization](https://docs.triliumnotes.org/user-guide/setup/synchronization)
* [Synchronisation](https://docs.triliumnotes.org/user-guide/setup/synchronization)
with self-hosted sync server
* there are [3rd party services for hosting synchronisation
server](https://docs.triliumnotes.org/user-guide/setup/server/cloud-hosting)
@@ -106,7 +106,7 @@ Our documentation is available in multiple formats:
* [Relation
maps](https://docs.triliumnotes.org/user-guide/note-types/relation-map) and
[note/link maps](https://docs.triliumnotes.org/user-guide/note-types/note-map)
for visualizing notes and their relations
for visualising notes and their relations
* Mind maps, based on [Mind Elixir](https://docs.mind-elixir.com/)
* [Geo maps](https://docs.triliumnotes.org/user-guide/collections/geomap) with
location pins and GPX tracks
@@ -115,7 +115,7 @@ Our documentation is available in multiple formats:
* [REST API](https://docs.triliumnotes.org/user-guide/advanced-usage/etapi) for
automation
* Scales well in both usability and performance upwards of 100 000 notes
* Touch optimized [mobile
* Touch optimised [mobile
frontend](https://docs.triliumnotes.org/user-guide/setup/mobile-frontend) for
smartphones and tablets
* Built-in [dark
@@ -126,7 +126,7 @@ Our documentation is available in multiple formats:
export](https://docs.triliumnotes.org/user-guide/concepts/import-export/markdown)
* [Web Clipper](https://docs.triliumnotes.org/user-guide/setup/web-clipper) for
easy saving of web content
* Customizable UI (sidebar buttons, user-defined widgets, ...)
* Customisable UI (sidebar buttons, user-defined widgets, ...)
* [Metrics](https://docs.triliumnotes.org/user-guide/advanced-usage/metrics),
along with a Grafana Dashboard.
@@ -327,7 +327,7 @@ Consider supporting the main developer
- [PayPal](https://paypal.me/eliandoran)
- [Buy Me a Coffee](https://buymeacoffee.com/eliandoran)
## 🔑 License
## 🔑 Licence
Copyright 2017-2025 zadam, Elian Doran, and other contributors

2
docs/README-ja.md vendored
View File

@@ -63,7 +63,7 @@ Trilium Notes
* ートは任意の深さのツリーに配置できます。1つのートをツリー内の複数の場所に配置できます[クローン](https://docs.triliumnotes.org/user-guide/concepts/notes/cloning)を参照)
* 豊富な WYSIWYG ノートエディター 例:
表、画像、[数式](https://docs.triliumnotes.org/user-guide/note-types/text) とマークダウン
表、画像、[数式](https://docs.triliumnotes.org/user-guide/note-types/text) と markdown
[自動フォーマット](https://docs.triliumnotes.org/user-guide/note-types/text/markdown-formatting)
など
* 構文ハイライト表示を含む

356
docs/README-ug.md vendored Normal file
View File

@@ -0,0 +1,356 @@
<div align="center">
<sup>Special thanks to:</sup><br />
<a href="https://go.warp.dev/Trilium" target="_blank">
<img alt="Warp sponsorship" width="400" src="https://github.com/warpdotdev/brand-assets/blob/main/Github/Sponsor/Warp-Github-LG-03.png"><br />
Warp, built for coding with multiple AI agents<br />
</a>
<sup>Available for macOS, Linux and Windows</sup>
</div>
<hr />
# Trilium Notes
![GitHub Sponsors](https://img.shields.io/github/sponsors/eliandoran)
![LiberaPay patrons](https://img.shields.io/liberapay/patrons/ElianDoran)\
![Docker Pulls](https://img.shields.io/docker/pulls/triliumnext/trilium)
![GitHub Downloads (بارلىق ماتېرىياللار، بارلىق تارىخىي
نۇسخىلار)](https://img.shields.io/github/downloads/triliumnext/trilium/total)\
[![RelativeCI](https://badges.relative-ci.com/badges/Di5q7dz9daNDZ9UXi0Bp?branch=develop)](https://app.relative-ci.com/projects/Di5q7dz9daNDZ9UXi0Bp)
[![تەرجىمە قىلىنىش
ئەھۋالى](https://hosted.weblate.org/widget/trilium/svg-badge.svg)](https://hosted.weblate.org/engage/trilium/)
<!-- translate:off -->
<!-- LANGUAGE SWITCHER -->
[Chinese (Simplified Han script)](./README-ZH_CN.md) | [Chinese (Traditional Han
script)](./README-ZH_TW.md) | [English](../README.md) | [French](./README-fr.md)
| [German](./README-de.md) | [Greek](./README-el.md) | [Italian](./README-it.md)
| [Japanese](./README-ja.md) | [Romanian](./README-ro.md) |
[Spanish](./README-es.md)
<!-- translate:on -->
Trilium Notes بولسا ھەقسىز، ئوچۇق كودلۇق، سىستېما ھالقىغان، قاتلاملىق خاتىرە
قالدۇرۇش ئەپى بولۇپ، ئۇ ئاساسلىقى چوڭ تىپتىكى شەخسىي بىلىم ئامبىرى قۇرۇشقا
ئەھمىيەت بېرىدۇ.
<img src="./app.png" alt="Trilium Screenshot" width="1000">
## چۈشۈرۈش⏬
- [ئەڭ يېڭى نۇسخىسى](https://github.com/TriliumNext/Trilium/releases/latest)
مۇقىم نۇسخا، كۆپ ساندىكى ئابونتلارنىڭ ئىشلىتىشى تەۋسىيە قىلىنىدۇ.
- [كۈندىلىك
قۇرۇلما](https://github.com/TriliumNext/Trilium/releases/tag/nightly) مۇقىم
بولمىغان ئېچىش نۇسخىسى، ھەر كۈنى يېڭىلىنىدۇ، ئەڭ يېڭى ئىقتىدارلار ۋە
تۈزىتىشلەرنى ئۆز ئىچىگە ئالىدۇ.
## ھۆججەتلەر📚
بىزنىڭ تولۇق قوللانمىمىزنى كۆرۈڭ:
[docs.triliumnotes.org](https://docs.triliumnotes.org/)
بىزنىڭ قوللانمىمىزنىڭ بىر قانچە خىل شەكىلدىكى نۇسخىلىرى بار:
- **تور قوللانمىسى**:بىزنىڭ تولۇق قوللانمىمىزنى مۇشۇ شەكىلدە كۆرۈڭ:
[docs.triliumnotes.org](https://docs.triliumnotes.org/)
- **پروگرامما ئىچىدىكى ياردەم**: Trilium دا` F1` نى باسسىڭىزلا، پروگرامما ئىچىدە
ئوخشاش بىر قوللانمىنى بىۋاسىتە كۆرەلەيسىز
- **GitHub**:بۇ ئامباردىكى [ئابونت قوللانمىسىنى](./User%20Guide/User%20Guide/)
كۆرۈڭ
### تېز ئۇلانمىلار
- [ئابونت چۈشەندۈرۈشى](https://docs.triliumnotes.org/)
- [قاچىلاش چۈشەندۈرۈشى](https://docs.triliumnotes.org/user-guide/setup)
- [Docker
تەڭشەكلىرى](https://docs.triliumnotes.org/user-guide/setup/server/installation/docker)
- [TriliumNext نى دەرىجىسىنى
ئۆستۈرۈش](https://docs.triliumnotes.org/user-guide/setup/upgrading)
- [ئاساسىي ئۇقۇملار ۋە
ئالاھىدىلىكلەر](https://docs.triliumnotes.org/user-guide/concepts/notes)
- [شەخسىي بىلىم ئامبىرى
ئەندىزىسى](https://docs.triliumnotes.org/user-guide/misc/patterns-of-personal-knowledge)
## 🎁 ئىقتىدارلار
* خاتىرىلەرنى ھەر قانداق چوڭقۇرلۇقتىكى دەرەخسىمان قۇرۇلمىغا تەشكىللەشكە بولىدۇ.
بىرلا خاتىرىنى دەرەخنىڭ كۆپلىگەن ئورنىغا قويۇشقا بولىدۇ ([خاتىرىنى
كۆپەيتىش/كلونلاش](https://docs.triliumnotes.org/user-guide/concepts/notes/cloning)
غا قاراڭ)
* تۆت تەرەپتىن كۆرۈنىدىغان (WYSIWYG) بېيىتىلغان خاتىرە تەھرىرلىگۈچ، جەدۋەل،
رەسىم ۋە [ماتېماتىكىلىق
فورمۇلا](https://docs.triliumnotes.org/user-guide/note-types/text)نى قوللايدۇ،
ھەمدە Markdown نىڭ [ئاپتوماتىك
فورماتى](https://docs.triliumnotes.org/user-guide/note-types/text/markdown-formatting)غا
ئىگە
* [پروگرامما كودى
خاتىرىسى](https://docs.triliumnotes.org/user-guide/note-types/code)نى
تەھرىرلەشنى قوللايدۇ، كود نۇرىنى ئۆز ئىچىگە ئالىدۇ
* خاتىرىلەر ئارىسىدا تېز ۋە ئوڭاي
[يېتەكلەش](https://docs.triliumnotes.org/user-guide/concepts/navigation/note-navigation
پۈتۈن تېكىستلىك ئىزدەش، ھەمدە [خاتىرىگە فوكۇسلىنىش
(hoisting)](https://docs.triliumnotes.org/user-guide/concepts/navigation/note-hoisting)
* ئۈزۈلۈپ قالمايدىغان [خاتىرە نۇسخىسىنى
باشقۇرۇش](https://docs.triliumnotes.org/user-guide/concepts/notes/note-revisions)
* خاتىرە
[خاسلىقى](https://docs.triliumnotes.org/user-guide/advanced-usage/attributes)
خاتىرىلەرنى تەشكىللەش، سۈرۈشتۈرۈش ۋە يۇقىرى دەرىجىلىك
[script](https://docs.triliumnotes.org/user-guide/scripts)لەرگە ئىشلىتىلىدۇ
* UI ئىنگلىزچە، گېرمانچە، ئىسپانچە، فىرانسۇزچە، رۇمىنىيەچە ۋە خەنزۇچە تىللىرىدا
تەمىنلىنىدۇ
* تېخىمۇ بىخەتەر كىرىش ئۈچۈن [OpenID ۋە
TOTP](https://docs.triliumnotes.org/user-guide/setup/server/mfa) بىۋاسىتە بىر
گەۋدىلەشتۈرۈلگەن
* ئۆزى قۇرغان ماسقەدەملەش مۇلازىمىتىرى بىلەن
[ماسقەدەملەش](https://docs.triliumnotes.org/user-guide/setup/synchronization)
* [ماسقەدەملەش مۇلازىمىتىرىنى ئورۇنلاشتۇرۇش ئۈچۈن ئۈچىنچى تەرەپ
مۇلازىمىتى](https://docs.triliumnotes.org/user-guide/setup/server/cloud-hosting)
بار
* خاتىرىنى ئىنتېرنېت تورىغا
[ھەمبەھرىلەش](https://docs.triliumnotes.org/user-guide/advanced-usage/sharing)
(ئاشكارە ئېلان قىلىش
* ھەر بىر خاتىرە بىرلىك قىلىنغان كۈچلۈك [خاتىرە
شىفىرلاش](https://docs.triliumnotes.org/user-guide/concepts/notes/protected-notes)
* قولدا سىزىلغان/ئىزاھلىق رەسىم: [Excalidraw](https://excalidraw.com/) غا
ئاساسلانغان (خاتىرە تىپى «canvas»
* خاتىرە ۋە ئۇلارنىڭ مۇناسىۋىتىنى كۆرسىتىپ بېرىدىغان [مۇناسىۋەت
خەرىتىسى](https://docs.triliumnotes.org/user-guide/note-types/relation-map) ۋە
[خاتىرە/ئۇلانما
خەرىتىسى](https://docs.triliumnotes.org/user-guide/note-types/note-map)
* تەپەككۇر خەرىتىسى: [Mind Elixir](https://docs.mind-elixir.com/) غا ئاساسلانغان
* ئورۇن بەلگىلەش بەلگىسى ۋە GPX يۆنىلىش لىنىيىسى بولغان [جۇغراپىيىلىك
خەرىتە](https://docs.triliumnotes.org/user-guide/collections/geomap)
* [Script](https://docs.triliumnotes.org/user-guide/scripts) - [ئىلغار
كۆرسىتىش](https://docs.triliumnotes.org/user-guide/advanced-usage/advanced-showcases)گە
قاراڭ
* ئاپتوماتلاشتۇرۇش ئۈچۈن ئىشلىتىلىدىغان [REST
API](https://docs.triliumnotes.org/user-guide/advanced-usage/etapi)
* ئىشلىتىشچانلىقى ۋە ئۈنۈمى جەھەتتە ياخشى كېڭىيىشچانلىققا ئىگە، 100,000 دىن
ئارتۇق خاتىرىنى قوللايدۇ
* يانفون ۋە تاختا كومپيۇتېر ئۈچۈن ئەلالاشتۇرۇلغان [كۆچمە
تەرەپ](https://docs.triliumnotes.org/user-guide/setup/mobile-frontend)
* ئىچىگە ئورۇنلاشتۇرۇلغان [قېنىق رەڭلىك
تېما](https://docs.triliumnotes.org/user-guide/concepts/themes)
* [Evernote دىن
ئەكىرىش](https://docs.triliumnotes.org/user-guide/concepts/import-export/evernote)
ۋە [Markdown نى ئەكىرىش ھەم
چىقىرىش](https://docs.triliumnotes.org/user-guide/concepts/import-export/markdown)
* توردىكى مەزمۇنلارنى تېز ساقلاشقا ئىشلىتىلىدىغان [Web
Clipper](https://docs.triliumnotes.org/user-guide/setup/web-clipper)
* ئىختىيارىي تەڭشىگىلى بولىدىغان UI (يان تىزىملىك كۇنۇپكىلىرى، ئىشلەتكۈچى ئۆزى
بەلگىلىگەن كىچىك قوراللار قاتارلىقلار)
* [Metrics ](https://docs.triliumnotes.org/user-guide/advanced-usage/metrics
شۇنداقلا Grafana كۆرسىتىش تاختىسى.
✨ تېخىمۇ كۆپ TriliumNext تېمىلىرى، قوليازما، قىستۇرما ۋە مەنبەلەرگە ئېرىشمەكچى
بولسىڭىز، تۆۋەندىكى ئۈچىنچى تەرەپ مەنبەلىرى ياكى جەمئىيەتلىرىدىن پايدىلانسىڭىز
بولىدۇ:
- [awesome-trilium](https://github.com/Nriver/awesome-trilium) (ئۈچىنچى تەرەپ
تېمىلىرى، قوليازمىلار، قىستۇرمىلار ۋە باشقىلار).
- [TriliumRocks!](https://trilium.rocks/) (دەرسلىكلەر، يېتەكچىلەر ۋە باشقىلار).
## ⚠️ نېمە ئۈچۈن TriliumNext نى تاللايمىز؟
Trilium نىڭ ئەسلى ئىجادچىسى ([Zadam](https://github.com/zadam)) سېخىيلىق بىلەن
Trilium كود ئامبىرىنى جەمئىيەت تۈرىگە ئۆتكۈزۈپ بەردى، بۇ تۈر ھازىر مۇشۇ ئادرېستا
ساقلىنىۋاتىدۇ: https://github.com/TriliumNext
### ⬆️ Trilium دىن كۆچۈرۈش؟
zadam/Trilium نۇسخىسىدىن TriliumNext/Notes غا كۆچۈش ئۈچۈن ئالاھىدە كۆچۈرۈش
باسقۇچلىرى كېرەك ئەمەس. [TriliumNext/Notes نى ئادەتتىكى ئۇسۇلدا
قاچىلىسىڭىزلا](#-installation)(#-install)، ئۇ بىۋاسىتە ھازىرقى ساندانىڭىزنى
ئىشلىتىدۇ.
[v0.90.4](https://github.com/TriliumNext/Trilium/releases/tag/v0.90.4) غىچە
بولغان نەشرلىرى zadam/trilium نىڭ ئەڭ يېڭى
[v0.63.7](https://github.com/zadam/trilium/releases/tag/v0.63.7) نەشرى بىلەن
ماسلىشىدۇ. ئۇنىڭدىن كېيىنكى TriliumNext نەشرلىرىدە ماسقەدەملەش نەشر نومۇرى
ئۆستۈرۈلگەن بولۇپ، يۇقىرىقىلار بىلەن ماسلاشمايدۇ.
## 💬 بىز بىلەن پىكىر ئالماشتۇرۇڭ
رەسمىي جەمئىيىتىمىزگە كەلگەنلىكىڭىزنى قارشى ئالىمىز. بىز سىزنىڭ ئىقتىدار، تەكلىپ
ياكى مەسىلىلەر ھەققىدىكى پىكىرلىرىڭىزنى ئاڭلاشنى ئارزۇ قىلىمىز!
- [Matrix](https://matrix.to/#/#triliumnext:matrix.org) (ماسقەدەملىك مۇنازىرە)
- `General `Matrix ئۆيىمۇ [XMPP](xmpp:discuss@trilium.thisgreat.party?join) غا
ئۇلانغان
- [GitHub Discussions](https://github.com/TriliumNext/Trilium/discussions)
(ئاسىنكرون مۇنازىرە).
- [GitHub Issues](https://github.com/TriliumNext/Trilium/issues) (خاتالىق مەلۇم
قىلىش ۋە ئىقتىدار ئېھتىياجىنى ئوتتۇرىغا قويۇش).
## 🏗 قاچىلاش
### Windows / MacOS
[ئەڭ يېڭى نەشرى بېتى](https://github.com/TriliumNext/Trilium/releases/latest)دىن
سۇپىڭىزغا ماس كېلىدىغان سىستېما ھۆججىتىنى چۈشۈرۈڭ، پرېستىن يەشكەندىن كېيىن
`trilium` ئىجرا ھۆججىتىنى قوزغىتىڭ.
### Linux
ئەگەر سىز ئىشلىتىۋاتقان نەشرى تۆۋەندىكى جەدۋەلدە بولسا، شۇ نەشرىنىڭ يۇمشاق دېتال
بوغچىسىنى ئىشلىتىڭ.
[![بوغچىلاش
ھالىتى](https://repology.org/badge/vertical-allrepos/triliumnext.svg)](https://repology.org/project/triliumnext/versions)
سىز يەنە [ئەڭ يېڭى ئېلان قىلىنغان
بەت](https://github.com/TriliumNext/Trilium/releases/latest)تىن مۇناسىپ سۇپىنىڭ
سىستېما ھۆججىتىنى چۈشۈرۈپ، پرېستىن يېشىپ بولغاندىن كېيىن trilium ئىجرا ھۆججىتىنى
قوزغاتسىڭىز بولىدۇ.
TriliumNext يەنە Flatpak نۇسخىسى بىلەن تەمىنلەيدۇ، ئەمما تېخى FlatHub غا
چىقىرىلمىدى.
### Browser (ھەرقانداق مەشغۇلات سىستېمىسى)
ئەگەر سىزدە (تۆۋەندىكىدەك) مۇلازىمىتىر قاچىلانمىسى بولسا، تور كۆرۈنمە يۈزىنى
بىۋاسىتە ساقىلالايسىز (ئۇ بىر تەرەپ قىلغۇچ دېتالى بىلەن ئاساسەن ئوخشاش)
نۆۋەتتە پەقەت Chrome ۋە Firefox نىڭ ئەڭ يېڭى نەشرىنىلا قوللايدۇ (ھەمدە ئەمەلىي
سىناقتىن ئۆتكەن).
### كۆچمە ئۈسكۈنە
ئەگەر كۆچمە ئۈسكۈنىلەردە TriliumNext نى ئىشلەتمەكچى بولسىڭىز، كۆچمە كۆرگۈچ
ئارقىلىق مۇلازىمىتىرغا قاچىلانغان كۆچمە نۇسخا كۆرۈنمە يۈزىنى زىيارەت قىلالايسىز
(تۆۋەنگە قاراڭ).
كۆچمە دېتال قوللاشقا ئائىت تېخىمۇ كۆپ ئۇچۇرلار ئۈچۈن،
https://github.com/TriliumNext/Trilium/issues/4962 مەسىلە بېتىگە قاراڭ.
ئەگەر سىز ئەسلى Android دېتالىنى ئىشلىتىشكە ئامراق بولسىڭىز،
[TriliumDroid](https://apt.izzysoft.de/fdroid/index/apk/eu.fliegendewurst.triliumdroid)
نى ئىشلەتسىڭىز بولىدۇ. مەسىلە ياكى كەم بولغان ئىقتىدارلارنى مەلۇم قىلماقچى
بولسىڭىز، [ئۇنىڭ ئامبىرى](https://github.com/FliegendeWurst/TriliumDroid) غا
مەرھەمەت.
### Server
ئەگەر ئۆزىڭىزنىڭ مۇلازىمىتىرىغا TriliumNext نى قاچىلىماقچى بولسىڭىز ([Docker
Hub](https://hub.docker.com/r/triliumnext/trilium) دىن Docker ئارقىلىق
ئورۇنلاشتۇرۇشنىمۇ ئۆز ئىچىگە ئالىدۇ)، [مۇلازىمىتىر قاچىلاش
ھۆججىتى](https://docs.triliumnotes.org/user-guide/setup/server) گە ئەمەل قىلىڭ.
## 💻 تۆھپە قوشۇش
### تەرجىمە
ئەگەر سىز شۇ تىلنىڭ ئىگىسى بولسىڭىز، بىزنىڭ [Weblate
بېتىمىز](https://hosted.weblate.org/engage/trilium/)گە كىرىپ Trilium نىڭ تەرجىمە
قىلىنىشىغا ياردەم بېرىشىڭىزنى قارشى ئالىمىز.
تۆۋەندىكىسى نۆۋەتتىكى تىللارنىڭ قاپلىنىش ئەھۋالى:
[![تەرجىمە
ئەھۋالى](https://hosted.weblate.org/widget/trilium/multi-auto.svg)](https://hosted.weblate.org/engage/trilium/)
### پروگرامما كودى
ئامبارنى چۈشۈرۈڭ، `pnpm` ئارقىلىق بېقىندى زاپچاسلارنى قاچىلاڭ، ئاندىن
مۇلازىمىتىرنى قوزغىتىڭ (مۇلازىمەت ئادرېسى: http://localhost:8080):
```shell
git clone https://github.com/TriliumNext/Trilium.git
cd Trilium
pnpm install
pnpm run server:start
```
### ھۆججەت
ئامبارنى چۈشۈرۈڭ، `pnpm` ئارقىلىق بېقىندى زاپچاسلارنى قاچىلاڭ، ئاندىن ھۆججەت
تەھرىرلەشكە ئېھتىياجلىق مۇھىتنى قوزغىتىڭ:
```shell
git clone https://github.com/TriliumNext/Trilium.git
cd Trilium
pnpm install
pnpm edit-docs:edit-docs
```
### ئىجرا قىلىنىدىغان ھۆججەتنى قۇرۇش
ئامبارنى چۈشۈرۈڭ، `pnpm` ئارقىلىق بېقىندى زاپچاسلارنى قاچىلاڭ، ئاندىن Windows
ئۈچۈن ئۈستەلئۈستى ئەپىنى قۇرۇپ چىقىڭ:
```shell
git clone https://github.com/TriliumNext/Trilium.git
cd Trilium
pnpm install
pnpm run --filter desktop electron-forge:make --arch=x64 --platform=win32
```
تېخىمۇ كۆپ تەپسىلاتلار ئۈچۈن [تەتقىقات
ھۆججەت](https://github.com/TriliumNext/Trilium/tree/main/docs/Developer%20Guide/Developer%20Guide)گە
قاراڭ.
### تەتقىقاتچى ھۆججەتلىرى
تەپسىلاتلار ئۈچۈن [ھۆججەت
يېتەكچىسى](https://github.com/TriliumNext/Trilium/blob/main/docs/Developer%20Guide/Developer%20Guide/Environment%20Setup.md)گە
قاراڭ. ئەگەر تېخىمۇ كۆپ سوئاللىرىڭىز بولسا، ئۈستىدىكى "بىز بىلەن ئالاقىلىشىڭ"
بۆلىكىدە تەمىنلەنگەن ئۇلىنىشلار ئارقىلىق بىز بىلەن ئالاقىلىشىڭنى قارشى ئالىمىز.
## 👏 مىننەتدارلىق
* ئەپنىڭ ئەسلى ئۇقۇم لاھىيەسى ۋە ئەمەلگە ئاشۇرۇلۇشىغا تۆھپە قوشقان
[zadam](https://github.com/zadam).
* ئەپ سىنبەلگىسىنى لاھىيەلىگەن [Sarah
Hussein](https://github.com/Sarah-Hussein).
* خەلقئارالاشتۇرۇش خىزمىتىگە تۆھپە قوشقان [nriver](https://github.com/nriver).
* Canvas جەھەتتىكى ئەسلى ئىجادىي خىزمەتلىرى ئۈچۈن [Thomas
Frei](https://github.com/thfrei).
* ئەسلى گرامماتىكا گەۋدىلەندۈرۈش كىچىك زاپچاسلارنى ئاپتورى
[antoniotejada](https://github.com/nriver).
* GitHub مەسىلىلىرى ۋە مۇنازىرىلىرىگە ئاپتوماتىك جاۋاب قايتۇرۇش بىلەن تەمىنلىگەن
[Dosu](https://dosu.dev/).
* سىستېما تەخسىسى سىنبەلگىسى ئۈچۈن [Tabler Icons](https://tabler.io/icons)
ئىشلىتىلدى.
ئارقا سەپتىكى تېخنىكىلارنىڭ قوللىشى بولمىسا، Trilium تۈرىنى ئەمەلگە ئاشۇرغىلى
بولمايتتى:
* [CKEditor 5](https://github.com/ckeditor/ckeditor5) —— تېكىستلىك خاتىرىلەرنىڭ
ئارقا سىپىدىكى كۆرۈنۈشچان تەھرىرلىگۈچ. بىز بۇ يۇقىرى دەرىجىلىك ئىقتىدارلارنى
ئىشلىتىش ھوقۇقىغا ئېرىشكەنلىكىمىزدىن تولىمۇ مىننەتدارمىز.
* [CodeMirror](https://github.com/codemirror/CodeMirror) —— كۆپلىگەن پروگرامما
تىللىرىنى قوللايدىغان كود تەھرىرلىگۈچ.
* [Excalidraw](https://github.com/excalidraw/excalidraw) —— (Canvas) خاتىرىسىدە
ئىشلىتىلىدىغان چەكسىز ئاق دوسكا.
* [Mind Elixir](https://github.com/SSShooter/mind-elixir-core) —— تەپەككۇر
خەرىتىسى ئىقتىدارى بىلەن تەمىنلەيدۇ.
* [Leaflet](https://github.com/Leaflet/Leaflet) —— جۇغراپىيەلىك خەرىتىلەرنى
تەسۋىرلەش (Render) ئۈچۈن ئىشلىتىلىدۇ.
* [Tabulator](https://github.com/olifolkerd/tabulator) —— توپلاملاردىكى ئۆزئارا
تەسىرلىشىدىغان جەدۋەللەر ئۈچۈن ئىشلىتىلىدۇ.
* [FancyTree](https://github.com/mar10/fancytree) —— ئىقتىدارى مول بولغان
دەرەخسىمان كونترول كۇتۇپخانىسى، ئۇنىڭغا تەڭ كېلىدىغان باشقا بىر كۇتۇپخانا يوق.
* [jsPlumb](https://github.com/jsplumb/jsplumb) —— كۆرۈنۈشچان ئۇلىنىش
كۇتۇپخانىسى. مۇناسىۋەت خەرىتىسى
(https://docs.triliumnotes.org/user-guide/note-types/relation-map) ۋە ئۇلىنىش
خەرىتىسى
(https://docs.triliumnotes.org/user-guide/advanced-usage/note-map#link-map)
ئۈچۈن ئىشلىتىلىدۇ.
## 🤝 بىزنى قوللاش
Trilium نى ئېچىش ۋە ئاسراشقا [يۈزلىگەن سائەت
خىزمەت](https://github.com/TriliumNext/Trilium/graphs/commit-activity)
سىڭدۈرۈلگەن. سىزنىڭ قوللىشىڭىز ئۇنىڭ ئوچۇق كودلۇق خاراكتېرىگە كاپالەتلىك قىلىدۇ،
ئىقتىدارلىرىنىڭ ياخشىلىنىشىنى ئىلگىرى سۈرىدۇ ھەمدە مۇلازىمېتىر تەننەرخى قاتارلىق
چىقىملارنى قامدايدۇ.
تۆۋەندىكى ئۇسۇللار ئارقىلىق بۇ ئەپنىڭ ئاساسلىق ئاچقۇچىسى
([eliandoran](https://github.com/eliandoran)) نى قوللاشنى ئويلىشىپ كۆرۈڭ:
- [GitHub Sponsors](https://github.com/sponsors/eliandoran)
- [PayPal](https://paypal.me/eliandoran)
- [Buy Me a Coffee](https://buymeacoffee.com/eliandoran)
## 🔑 ئىجازەتنامە شەرتلىرى
نەشر ھوقۇقى 20172025 zadam، Elian Doran ۋە باشقا تۆھپىكارلارغا تەۋە
بۇ پىروگرامما ئەركىن يۇمشاق دېتال: سىز ئەركىن يۇمشاق دېتال فوندى جەمئىيىتى (Free
Software Foundation) ئېلان قىلغان GNU Affero ئومۇمىي ئاممىۋى ئىجازەتنامىسى (GNU
AGPL) نىڭ 3-نەشرى ياكى (تاللىشىڭىزغا ئاساسەن) ھەر قانداق كېيىنكى نەشرىنىڭ
شەرتلىرىگە ئاساسەن، بۇ پىروگراممىنى قايتا تارقىتسىڭىز ياكى ئۆزگەرتسىڭىز بولىدۇ.

View File

@@ -3962,6 +3962,83 @@
"attachments": []
}
]
},
{
"isClone": false,
"noteId": "SL5f1Auq7sVN",
"notePath": [
"pOsGYCXsbNQG",
"gh7bpGYxajRS",
"Vc8PjrjAGuOp",
"SL5f1Auq7sVN"
],
"title": "Note types with split view",
"notePosition": 230,
"prefix": null,
"isExpanded": false,
"type": "text",
"mime": "text/html",
"attributes": [
{
"type": "relation",
"name": "internalLink",
"value": "s1aBHPd79XYj",
"isInheritable": false,
"position": 10
},
{
"type": "relation",
"name": "internalLink",
"value": "6RM1Q7ppFVoj",
"isInheritable": false,
"position": 20
},
{
"type": "relation",
"name": "internalLink",
"value": "8YBEPzcpUgxw",
"isInheritable": false,
"position": 30
},
{
"type": "relation",
"name": "internalLink",
"value": "IjZS7iK5EXtb",
"isInheritable": false,
"position": 40
},
{
"type": "relation",
"name": "internalLink",
"value": "XpOYSgsLkTJy",
"isInheritable": false,
"position": 50
},
{
"type": "relation",
"name": "internalLink",
"value": "CoFPLs3dRlXc",
"isInheritable": false,
"position": 60
},
{
"type": "label",
"name": "iconClass",
"value": "bx bx-card",
"isInheritable": false,
"position": 90
},
{
"type": "label",
"name": "shareAlias",
"value": "note-types-with-split-view",
"isInheritable": false,
"position": 100
}
],
"format": "markdown",
"dataFileName": "Note types with split view.md",
"attachments": []
}
]
},
@@ -4445,10 +4522,52 @@
{
"type": "relation",
"name": "internalLink",
"value": "zEY4DaJG4YT5",
"value": "IjZS7iK5EXtb",
"isInheritable": false,
"position": 10
},
{
"type": "relation",
"name": "internalLink",
"value": "8YBEPzcpUgxw",
"isInheritable": false,
"position": 20
},
{
"type": "relation",
"name": "internalLink",
"value": "A9Oc6YKKc65v",
"isInheritable": false,
"position": 30
},
{
"type": "relation",
"name": "internalLink",
"value": "F1r9QtzQLZqm",
"isInheritable": false,
"position": 40
},
{
"type": "relation",
"name": "internalLink",
"value": "pgxEVkzLl1OP",
"isInheritable": false,
"position": 50
},
{
"type": "relation",
"name": "internalLink",
"value": "GBBMSlVSOIGP",
"isInheritable": false,
"position": 60
},
{
"type": "relation",
"name": "internalLink",
"value": "zEY4DaJG4YT5",
"isInheritable": false,
"position": 70
},
{
"type": "label",
"name": "shareAlias",
@@ -4468,12 +4587,28 @@
"dataFileName": "Note Revisions.md",
"attachments": [
{
"attachmentId": "1TA1nUFZzprY",
"title": "note-revisions.png",
"attachmentId": "BHquVQR30ess",
"title": "image.png",
"role": "image",
"mime": "image/png",
"position": 10,
"dataFileName": "Note Revisions_note-revisi.png"
"dataFileName": "Note Revisions_image.png"
},
{
"attachmentId": "eoYsKZfMMvlg",
"title": "image.png",
"role": "image",
"mime": "image/png",
"position": 10,
"dataFileName": "1_Note Revisions_image.png"
},
{
"attachmentId": "w1kmtyCISdjQ",
"title": "image.png",
"role": "image",
"mime": "image/png",
"position": 10,
"dataFileName": "2_Note Revisions_image.png"
}
]
},
@@ -4556,13 +4691,6 @@
"isInheritable": false,
"position": 20
},
{
"type": "relation",
"name": "internalLink",
"value": "zEY4DaJG4YT5",
"isInheritable": false,
"position": 30
},
{
"type": "relation",
"name": "internalLink",
@@ -4667,13 +4795,41 @@
"value": "printing-and-pdf-export",
"isInheritable": false,
"position": 110
},
{
"type": "relation",
"name": "internalLink",
"value": "8YBEPzcpUgxw",
"isInheritable": false,
"position": 170
},
{
"type": "relation",
"name": "internalLink",
"value": "A9Oc6YKKc65v",
"isInheritable": false,
"position": 180
},
{
"type": "relation",
"name": "internalLink",
"value": "F1r9QtzQLZqm",
"isInheritable": false,
"position": 190
},
{
"type": "relation",
"name": "internalLink",
"value": "zEY4DaJG4YT5",
"isInheritable": false,
"position": 200
}
],
"format": "markdown",
"dataFileName": "Printing & Exporting as PDF.md",
"attachments": [
{
"attachmentId": "NfSjRsArIQHy",
"attachmentId": "Om2EmdZr54vy",
"title": "image.png",
"role": "image",
"mime": "image/png",
@@ -4681,7 +4837,7 @@
"dataFileName": "Printing & Exporting as PD.png"
},
{
"attachmentId": "Om2EmdZr54vy",
"attachmentId": "V7LPRqK96Vjy",
"title": "image.png",
"role": "image",
"mime": "image/png",
@@ -5093,7 +5249,7 @@
"wArbEsdSae6g",
"F1r9QtzQLZqm"
],
"title": "Jump to...",
"title": "Jump to & command palette",
"notePosition": 50,
"prefix": null,
"isExpanded": false,
@@ -5130,7 +5286,7 @@
}
],
"format": "markdown",
"dataFileName": "Jump to.md",
"dataFileName": "Jump to & command palette.md",
"attachments": [
{
"attachmentId": "7IU5WrneDsfi",
@@ -5138,7 +5294,7 @@
"role": "image",
"mime": "image/png",
"position": 10,
"dataFileName": "Jump to_image.png"
"dataFileName": "Jump to & command palette_.png"
},
{
"attachmentId": "P9veX5eFZdPp",
@@ -5146,7 +5302,7 @@
"role": "image",
"mime": "image/png",
"position": 10,
"dataFileName": "1_Jump to_image.png"
"dataFileName": "1_Jump to & command palette_.png"
},
{
"attachmentId": "y8yxomaf1Gkz",
@@ -5154,7 +5310,7 @@
"role": "image",
"mime": "image/png",
"position": 10,
"dataFileName": "2_Jump to_image.png"
"dataFileName": "2_Jump to & command palette_.png"
}
]
},
@@ -7111,6 +7267,93 @@
],
"dirFileName": "Text",
"children": [
{
"isClone": false,
"noteId": "oSuaNgyyKnhu",
"notePath": [
"pOsGYCXsbNQG",
"KSZ04uQ2D1St",
"iPIMuisry3hd",
"oSuaNgyyKnhu"
],
"title": "Anchors",
"notePosition": 10,
"prefix": null,
"isExpanded": false,
"type": "text",
"mime": "text/html",
"attributes": [
{
"type": "relation",
"name": "internalLink",
"value": "u3YFHC9tQlpm",
"isInheritable": false,
"position": 10
},
{
"type": "relation",
"name": "internalLink",
"value": "QEAPj01N5f7w",
"isInheritable": false,
"position": 20
},
{
"type": "relation",
"name": "internalLink",
"value": "nRhnJkTT8cPs",
"isInheritable": false,
"position": 30
},
{
"type": "relation",
"name": "internalLink",
"value": "ZlN4nump6EbW",
"isInheritable": false,
"position": 40
},
{
"type": "relation",
"name": "internalLink",
"value": "hrZ1D00cLbal",
"isInheritable": false,
"position": 50
},
{
"type": "label",
"name": "iconClass",
"value": "bx bx-bookmark",
"isInheritable": false,
"position": 10
},
{
"type": "label",
"name": "shareAlias",
"value": "bookmarks",
"isInheritable": false,
"position": 30
}
],
"format": "markdown",
"dataFileName": "Anchors.md",
"attachments": [
{
"attachmentId": "2cn9iY3Qgyjs",
"title": "plus.png",
"role": "image",
"mime": "image/png",
"position": 10,
"dataFileName": "Anchors_plus.png"
},
{
"attachmentId": "JaiAT3dHDIyy",
"title": "plus.png",
"role": "image",
"mime": "image/png",
"position": 10,
"dataFileName": "1_Anchors_plus.png"
}
]
},
{
"isClone": false,
"noteId": "NwBbFdNZ9h7O",
@@ -7121,7 +7364,7 @@
"NwBbFdNZ9h7O"
],
"title": "Block quotes & admonitions",
"notePosition": 10,
"notePosition": 20,
"prefix": null,
"isExpanded": false,
"type": "text",
@@ -7185,72 +7428,6 @@
}
]
},
{
"isClone": false,
"noteId": "oSuaNgyyKnhu",
"notePath": [
"pOsGYCXsbNQG",
"KSZ04uQ2D1St",
"iPIMuisry3hd",
"oSuaNgyyKnhu"
],
"title": "Bookmarks",
"notePosition": 20,
"prefix": null,
"isExpanded": false,
"type": "text",
"mime": "text/html",
"attributes": [
{
"type": "relation",
"name": "internalLink",
"value": "QEAPj01N5f7w",
"isInheritable": false,
"position": 10
},
{
"type": "relation",
"name": "internalLink",
"value": "nRhnJkTT8cPs",
"isInheritable": false,
"position": 20
},
{
"type": "label",
"name": "iconClass",
"value": "bx bx-bookmark",
"isInheritable": false,
"position": 10
},
{
"type": "label",
"name": "shareAlias",
"value": "bookmarks",
"isInheritable": false,
"position": 30
}
],
"format": "markdown",
"dataFileName": "Bookmarks.md",
"attachments": [
{
"attachmentId": "2cn9iY3Qgyjs",
"title": "plus.png",
"role": "image",
"mime": "image/png",
"position": 10,
"dataFileName": "Bookmarks_plus.png"
},
{
"attachmentId": "JaiAT3dHDIyy",
"title": "plus.png",
"role": "image",
"mime": "image/png",
"position": 10,
"dataFileName": "1_Bookmarks_plus.png"
}
]
},
{
"isClone": false,
"noteId": "veGu4faJErEM",
@@ -9700,6 +9877,20 @@
"value": "bx bx-code",
"isInheritable": false,
"position": 90
},
{
"type": "relation",
"name": "internalLink",
"value": "8YBEPzcpUgxw",
"isInheritable": false,
"position": 100
},
{
"type": "relation",
"name": "internalLink",
"value": "IjZS7iK5EXtb",
"isInheritable": false,
"position": 110
}
],
"format": "markdown",
@@ -10070,17 +10261,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",
@@ -10739,6 +10937,124 @@
"dataFileName": "Spreadsheets_image.png"
}
]
},
{
"isClone": false,
"noteId": "6RM1Q7ppFVoj",
"notePath": [
"pOsGYCXsbNQG",
"KSZ04uQ2D1St",
"6RM1Q7ppFVoj"
],
"title": "Markdown",
"notePosition": 230,
"prefix": null,
"isExpanded": false,
"type": "text",
"mime": "text/html",
"attributes": [
{
"type": "relation",
"name": "internalLink",
"value": "Oau6X9rCuegd",
"isInheritable": false,
"position": 10
},
{
"type": "relation",
"name": "internalLink",
"value": "iPIMuisry3hd",
"isInheritable": false,
"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": "NwBbFdNZ9h7O",
"isInheritable": false,
"position": 50
},
{
"type": "relation",
"name": "internalLink",
"value": "YfYAtQBcfo5V",
"isInheritable": false,
"position": 60
},
{
"type": "relation",
"name": "internalLink",
"value": "s1aBHPd79XYj",
"isInheritable": false,
"position": 70
},
{
"type": "relation",
"name": "internalLink",
"value": "nBAXQFj20hS1",
"isInheritable": false,
"position": 80
},
{
"type": "relation",
"name": "internalLink",
"value": "hrZ1D00cLbal",
"isInheritable": false,
"position": 90
},
{
"type": "relation",
"name": "internalLink",
"value": "m1lbrzyKDaRB",
"isInheritable": false,
"position": 100
},
{
"type": "relation",
"name": "internalLink",
"value": "oPVyFC7WL2Lp",
"isInheritable": false,
"position": 110
},
{
"type": "relation",
"name": "internalLink",
"value": "wy8So3yZZlH9",
"isInheritable": false,
"position": 120
},
{
"type": "label",
"name": "iconClass",
"value": "bx bxl-markdown",
"isInheritable": false,
"position": 30
},
{
"type": "label",
"name": "shareAlias",
"value": "markdown",
"isInheritable": false,
"position": 40
}
],
"format": "markdown",
"dataFileName": "Markdown.md",
"attachments": []
}
]
},
@@ -16453,19 +16769,19 @@
"isInheritable": false,
"position": 30
},
{
"type": "relation",
"name": "internalLink",
"value": "hrZ1D00cLbal",
"isInheritable": false,
"position": 40
},
{
"type": "label",
"name": "shareAlias",
"value": "word-count",
"isInheritable": false,
"position": 40
},
{
"type": "relation",
"name": "internalLink",
"value": "hrZ1D00cLbal",
"isInheritable": false,
"position": 50
}
],
"format": "markdown",
@@ -18056,6 +18372,33 @@
"dataFileName": "Patterns of personal knowl.png"
}
]
},
{
"isClone": false,
"noteId": "d1Ap6Pg6IjaJ",
"notePath": [
"pOsGYCXsbNQG",
"Fm0j45KqyHpU",
"d1Ap6Pg6IjaJ"
],
"title": "License",
"notePosition": 40,
"prefix": null,
"isExpanded": false,
"type": "text",
"mime": "text/html",
"attributes": [
{
"type": "label",
"name": "shareAlias",
"value": "license",
"isInheritable": false,
"position": 30
}
],
"format": "markdown",
"dataFileName": "License.md",
"attachments": []
}
]
}

View File

@@ -13,6 +13,7 @@ As such, there are third-party solutions that integrate an MCP server that can b
* [tan-yong-sheng/triliumnext-mcp](https://github.com/tan-yong-sheng/triliumnext-mcp)
* [perfectra1n/triliumnext-mcp](https://github.com/perfectra1n/triliumnext-mcp)
* [eliassoares/trilium-fastmcp](https://github.com/eliassoares/trilium-fastmcp)
> [!IMPORTANT]
> These solutions are third-party and thus not endorsed or supported directly by the Trilium Notes team. Please address questions and issues on their corresponding repository instead.

View File

@@ -1,5 +1,5 @@
# Jump to...
<figure class="image image-style-align-center"><img style="aspect-ratio:991/403;" src="1_Jump to_image.png" width="991" height="403"></figure>
# Jump to & command palette
<figure class="image image-style-align-center"><img style="aspect-ratio:991/403;" src="1_Jump to &amp; command palette_.png" width="991" height="403"></figure>
## Jump to Note
@@ -7,7 +7,7 @@ The _Jump to Note_ function allows easy navigation between notes by searching fo
To enter the “Jump to” dialog:
* In the <a class="reference-link" href="../UI%20Elements/Launch%20Bar.md">Launch Bar</a>, press ![](2_Jump%20to_image.png) button.
* In the <a class="reference-link" href="../UI%20Elements/Launch%20Bar.md">Launch Bar</a>, press ![](2_Jump%20to%20&%20command%20palette_.png) button.
* Using the keyboard, press <kbd>Ctrl</kbd> + <kbd>J</kbd>.
In addition to searching for notes, it is also possible to search for commands. See the dedicated section below for more information.
@@ -28,7 +28,7 @@ Alternatively you can click on the "time" icon on the right.
## Command Palette
<figure class="image image-style-align-center"><img style="aspect-ratio:982/524;" src="Jump to_image.png" width="982" height="524"></figure>
<figure class="image image-style-align-center"><img style="aspect-ratio:982/524;" src="Jump to &amp; command palette_.png" width="982" height="524"></figure>
The command palette is a feature which allows easy execution of various commands that can be found throughout the application, such as from menus or keyboard shortcuts. This feature integrates directly into the “Jump to” dialog.

View File

@@ -13,4 +13,4 @@ This works identically to browser backwards / forwards, it's actually using buil
This is useful to quickly find and view arbitrary notes - click on `Jump to` button on the top or press <kbd>Ctrl</kbd> + <kbd>J</kbd> . Then type part of the note name and autocomplete will help you pick the desired note.
See <a class="reference-link" href="Jump%20to.md">Jump to Note</a> for more information.
See <a class="reference-link" href="Jump%20to%20%26%20command%20palette.md">Jump to Note</a> for more information.

View File

@@ -5,7 +5,7 @@ The _Quick search_ function does a full-text search (that is, it searches throug
The alternative to the quick search is the <a class="reference-link" href="Search.md">Search</a> function, which opens in a dedicated tab and has support for advanced queries.
For even faster navigation, it's possible to use <a class="reference-link" href="Jump%20to.md">Jump to...</a> which will only search through the note titles instead of the content.
For even faster navigation, it's possible to use <a class="reference-link" href="Jump%20to%20%26%20command%20palette.md">Jump to...</a> which will only search through the note titles instead of the content.
## Layout

Binary file not shown.

After

Width:  |  Height:  |  Size: 927 B

Binary file not shown.

Before

Width:  |  Height:  |  Size: 150 B

After

Width:  |  Height:  |  Size: 243 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 356 KiB

View File

@@ -1,20 +1,74 @@
# Note Revisions
<figure class="image"><img style="aspect-ratio:2089/1515;" src="2_Note Revisions_image.png" width="2089" height="1515"></figure>
Trilium supports seamless versioning of notes by storing snapshots ("revisions") of notes at regular intervals.
## Note Revisions Snapshot Interval
## Displaying the revisions
Time interval of taking note snapshot is configurable in the Options -> Other dialog. This provides a tradeoff between more revisions and more data to store.
* On the <a class="reference-link" href="../UI%20Elements/New%20Layout.md">New Layout</a>, press the [note context menu](../UI%20Elements/Note%20buttons.md) and select _Note revisions…_
* On the old layout, press directly the <img class="image_resized" style="aspect-ratio:27/25;width:2.32%;" src="1_Note Revisions_image.png" width="27" height="25"> button in the <a class="reference-link" href="../UI%20Elements/Note%20buttons.md">Note buttons</a> area.
To turn off note versioning for a particular note (or subtree), add `disableVersioning` [label](../../Advanced%20Usage/Attributes.md)to the note.
## Interaction
## Note Revision Snapshots Limit
> [!NOTE]
> This documentation matches the redesign of the note revisions dialog on v0.103.0, older versions have a similar dialog but with some differences.
* The full list of revisions are displayed on the left in reverse chronological order.
* The revisions are grouped by the date the revision was taken.
* This list does not contain the _current state_ of the note, so it is possible to have notes with no revisions/snapshots saved.
* The icon of a revision indicates the _source_ of that revision (e.g. a <img class="image_resized" style="aspect-ratio:20/21;width:2.49%;" src="Note Revisions_image.png" width="20" height="21"> icon for a manually saved revision).
* Pressing the \[…\] on the top-right of the dialog displays multiple options, including:
* Saving a new revision now.
* Checking the interval and limit for this note (see below).
* Deleting all the revisions of this note.
* For supported notes (text, code), changes are highlighted. This behavior can be toggled via the _Highlight changes_ at the top of the dialog.
* The highlighted changes are relative to the **current state of the note**, not to the revision prior to this one.
* For any given revision, the buttons on the top-right allow operating on it:
* Deleting the revision.
* Downloading the revision locally.
* Restoring the revision, which replaces the current content of the note with the one from the revision. Another revision is saved containing the current content of the note.
## Named revisions
Named revisions are a new feature of Trilium v0.103.0 which allows adding a short description of what the changes in the snapshot contain.
In the list of note revisions:
* The name of the revision is displayed underneath the time of the revision in the sidebar, as well as at the top of the dialog where it is displayed in full.
* Clicking on the edit button near the name of the revision allows it to be changed.
To create a named revision, either:
* Go to the <a class="reference-link" href="../UI%20Elements/Note%20buttons.md">Note buttons</a>, select _Save named revision…_, enter the name of revision and confirm.
* Use the corresponding [keyboard shortcut](../Keyboard%20Shortcuts.md) or the <a class="reference-link" href="../Navigation/Jump%20to%20%26%20command%20palette.md">Jump to...</a> command with the same name.
* Save a revision normally, and adjust the name afterwards from the note revision list.
## When revisions are saved
Revisions are saved:
* Automatically at a fixed interval. This behavior can be configured (see below).
* Manually, by:
* Going to the press the [note context menu](../UI%20Elements/Note%20buttons.md) and select _Save revision._
* Using the _Force Save Revision_ [keyboard shortcut](../Keyboard%20Shortcuts.md).
* In the _Revisions_ dialog, pressing the \[…\] button in the top-right and selecting _Save a revision now_.
Additionally, revisions can also come from somewhere else, and this is indicated via the icon of the revision:
* Generated externally, by <a class="reference-link" href="../../Advanced%20Usage/ETAPI%20(REST%20API).md">ETAPI (REST API)</a>.
* A modification created by <a class="reference-link" href="../../AI.md">AI</a>.
* A revision is restored, causing the existing note content to be saved as a revision to prevent potential data loss.
#### Snapshot interval
Time interval of taking note snapshot is configurable in the Options -> Other dialog. This provides a trade-off between more revisions and more data to store.
To turn off note versioning for a particular note (or sub-tree), add `disableVersioning` [label](../../Advanced%20Usage/Attributes.md) to the note.
#### Maximum revisions
The limit on the number of note snapshots can be configured in the Options -> Other dialog. The note revision snapshot number limit refers to the maximum number of revisions that can be saved for each note. Where -1 means no limit, 0 means delete all revisions. You can set the maximum revisions for a single note through the `versioningLimit=X` label.
The note limit will not take effect immediately; it will only apply when the note is modified.
You can click the **Erase excess revision snapshots now** button to apply the changes immediately.
Note revisions can be accessed through the button on the right of ribbon toolbar.
![](Note%20Revisions_note-revisi.png)
You can click the _Erase excess revision snapshots now_ button to apply the changes immediately.

Binary file not shown.

After

Width:  |  Height:  |  Size: 548 B

Binary file not shown.

Before

Width:  |  Height:  |  Size: 140 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 87 KiB

After

Width:  |  Height:  |  Size: 150 B

View File

@@ -1,29 +1,60 @@
# Printing & Exporting as PDF
<figure class="image"><img style="aspect-ratio:951/432;" src="Printing &amp; Exporting as PD.png" width="951" height="432"><figcaption>Screenshot of the note contextual menu indicating the “Export as PDF” option.</figcaption></figure>
<figure class="image"><img style="aspect-ratio:2023/1488;" src="1_Printing &amp; Exporting as PD.png" width="2023" height="1488"><figcaption>Screenshot of the Print preview functionality introduced in v0.103.0.</figcaption></figure>
## Printing
This feature allows printing of notes. It works on both the desktop client, but also on the web.
Trilium allows printing notes to a real printer, or generating a structured PDF for a single note or for multiple notes through <a class="reference-link" href="../../Collections.md">Collections</a>.
Note that not all note types are printable as of now. We do plan to increase the coverage of supported note types in the future.
To print a note, select the <img src="1_Printing &amp; Exporting as PD.png" width="29" height="31"> button to the right of the note and select _Print note_. Depending on the size and type of the note, this can take up to a few seconds. Afterwards you will be redirected to the system/browser printing dialog.
Printing and exporting as PDF are not perfect. Due to technical limitations, and sometimes even browser or Electron glitches the text might appear cut off in some circumstances. 
## Printing a note or exporting as PDF on the desktop
> [!NOTE]
> Printing and exporting as PDF are not perfect. Due to technical limitations, and sometimes even browser glitches the text might appear cut off in some circumstances. 
> Versions prior to v0.103.0 had two different options, one for printing and another one for exporting to PDF. With the introduction of the print preview, these functions have been unified.
On the desktop application of Trilium it is possible to export a note as PDF. To print a note:
* Press the menu button in the <a class="reference-link" href="../UI%20Elements/Note%20buttons.md">Note buttons</a> area and select _Print note_.
* Alternatively, printing can be triggered from a [keyboard shortcut](../Keyboard%20Shortcuts.md) (unassigned by default) or through the [command palette](../Navigation/Jump%20to%20%26%20command%20palette.md).
This will trigger the print preview screen next.
### Print preview & print options
The print preview dialog allows the following printing options to be adjusted:
* The printer to use
* _Save as PDF_ generates a PDF that is structured (maintains a table of contents, keeps the text selectable). Prefer this over other virtual PDF printers that ship with the operating system.
* Page orientation: _Portrait_ (default) or _Landscape_.
* Page size
* Scale the entire content from 10% to 200% to improve the fit within the page.
* Margins, which can be removed completely or adjusted individually for all the four edges.
* Print only a subset of pages. Individual page numbers are separated by colons and hyphen-based ranges are supported (e.g. 3-5 for pages 3 to 5).
Additional interaction:
* _Print using system dialog_ allows setting more options that are otherwise not available in Trilium.
> [!NOTE]
> Most of the options here (expect printer & which pages to print) are managed at note level through <a class="reference-link" href="../../Advanced%20Usage/Attributes.md">Attributes</a> (such as `#printLandscape`, `#printPageSize`, `#printScale`, `#printMargins`).
>
> This means that the print settings will be restored when printing the same note. There are no default settings that can be configured for all the notes, but this can be achieved via [inheritable attributes](../../Advanced%20Usage/Attributes/Attribute%20Inheritance.md).
## Printing on the browser
This feature allows printing of notes. It works on both the desktop client, but also on the web.
To print a note, select the <img src="Printing &amp; Exporting as PD.png" width="29" height="31"> button to the right of the note and select _Print note_. Depending on the size and type of the note, this can take up to a few seconds. Afterwards you will be redirected to the system/browser printing dialog.
On the server or PWA (mobile), the option is not available due to technical constraints and it will be hidden.
## Reporting issues with the rendering
Should you encounter any visual issues in the resulting PDF file (e.g. a table does not fit properly, there is cut off text, etc.) feel free to [report the issue](../../Troubleshooting/Reporting%20issues.md). In this case, it's best to offer a sample note (click on the <img src="1_Printing &amp; Exporting as PD.png" width="29" height="31"> button, select Export note → This note and all of its descendants → HTML in ZIP archive). Make sure not to accidentally leak any personal information.
Should you encounter any visual issues in the resulting PDF file (e.g. a table does not fit properly, there is cut off text, etc.) feel free to [report the issue](../../Troubleshooting/Reporting%20issues.md). In this case, it's best to offer a sample note (click on the <img src="Printing &amp; Exporting as PD.png" width="29" height="31"> button, select Export note → This note and all of its descendants → HTML in ZIP archive). Make sure not to accidentally leak any personal information.
Consider adjusting font sizes and using [page breaks](../../Note%20Types/Text/Insert%20buttons.md) to work around the layout.
## Exporting as PDF
On the desktop application of Trilium it is possible to export a note as PDF. On the server or PWA (mobile), the option is not available due to technical constraints and it will be hidden.
To print a note, select the ![](1_Printing%20&%20Exporting%20as%20PD.png) button to the right of the note and select _Export as PDF_. Afterwards you will be prompted to select where to save the PDF file.
> [!TIP]
> Although direct export as PDF is not available in the browser version of the application, it's still possible to generate a PDF by selecting the _Print_ option instead and selecting “Save to PDF” as the printer (depending on the browser). Generally, Mozilla Firefox has better printing capabilities.
@@ -39,16 +70,6 @@ To solve this, you can change the recommended application for PDFs via this comm
gio mime application/pdf
```
### Customizing exporting as PDF
When exporting to PDF, there are no customizable settings such as page orientation, size. However, there are a few <a class="reference-link" href="../../Advanced%20Usage/Attributes.md">Attributes</a> to adjust some of the settings:
* To print in landscape mode instead of portrait (useful for big diagrams or slides), add `#printLandscape`.
* By default, the resulting PDF will be in Letter format. It is possible to adjust it to another page size via the `#printPageSize` attribute, with one of the following values: `A0`, `A1`, `A2`, `A3`, `A4`, `A5`, `A6`, `Legal`, `Letter`, `Tabloid`, `Ledger`.
> [!NOTE]
> These options have no effect when used with the printing feature, since the user-defined settings are used instead.
## Printing multiple notes
Since v0.100.0, it is possible to print more than one note at the time by using <a class="reference-link" href="../../Collections.md">Collections</a>:
@@ -99,12 +120,15 @@ 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;
body{
--print-font-family: serif;
--print-font-size: 11pt;
}
```
> [!IMPORTANT]
> When altering `--print-font-family`, make sure the change is done at `body` level and not `:root`, since otherwise it won't be picked up due to specificity rules.
To remark:
* Multiple CSS notes can be add by using multiple `~printCss` relations.
@@ -117,4 +141,6 @@ Both printing and exporting as PDF use the same mechanism: a note is rendered in
The webpage that renders a single note can actually be accessed in a web browser. For example `http://localhost:8080/#root/WWRGzqHUfRln/RRZsE9Al8AIZ?ntxId=0o4fzk` becomes `http://localhost:8080/?print#root/WWRGzqHUfRln/RRZsE9Al8AIZ`.
Accessing the print note in a web browser allows for easy debugging to understand why a particular note doesn't render well. The mechanism for rendering is similar to the one used in <a class="reference-link" href="Note%20List.md">Note List</a>.
Accessing the print note in a web browser allows for easy debugging to understand why a particular note doesn't render well. The mechanism for rendering is similar to the one used in <a class="reference-link" href="Note%20List.md">Note List</a>.
1. <sup><strong><a href="#fnrefsr779u3zm6">^</a></strong></sup>

View File

@@ -40,4 +40,4 @@ When pressed, the note will become editable but will become read-only again afte
Some note types have a special behavior based on whether the read-only mode is enabled:
* <a class="reference-link" href="../../Note%20Types/Mermaid%20Diagrams.md">Mermaid Diagrams</a> will hide the Mermaid source code and display the diagram preview in full-size. In this case, the read-only mode can be easily toggled on or off via a dedicated button in the <a class="reference-link" href="../UI%20Elements/Floating%20buttons.md">Floating buttons</a> area.
* <a class="reference-link" href="../../Collections/Geo%20Map.md">Geo Map View</a> will disallow all interaction that would otherwise change the map (dragging notes, adding new items).
* <a class="reference-link" href="../../Collections/Geo%20Map.md">Geo Map</a> will disallow all interaction that would otherwise change the map (dragging notes, adding new items).

View File

@@ -0,0 +1,21 @@
# Note types with split view
Split view is a feature of <a class="reference-link" href="../../Note%20Types/Mermaid%20Diagrams.md">Mermaid Diagrams</a> and <a class="reference-link" href="../../Note%20Types/Markdown.md">Markdown</a> notes which displays both the source code on one side and the preview of the content on the other.
<a class="reference-link" href="../../Note%20Types/Mermaid%20Diagrams.md">Mermaid Diagrams</a> also allow changing between a horizontal or a vertical split, to accommodate for the various sizes of diagrams.
## Display modes and interaction
The split comes with three different display modes:
* _Split view_, in which both the source code is available on one side and can be edited, and the preview is available on the other side.
* In this mode, the size of either the source pane or the preview pane can be adjusted by dragging the small border between them.
* _Source view_ which shows the source code on the entire screen for a more focused editing experience.
* _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 <a class="reference-link" href="Note%20buttons.md">Note buttons</a> section on the <a class="reference-link" href="New%20Layout.md">New Layout</a>, or in the <a class="reference-link" href="Floating%20buttons.md">Floating buttons</a> 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](../Notes/Read-Only%20Notes.md), 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.

View File

@@ -77,6 +77,12 @@ 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.
To keep Electron data out of the system's roaming profile, set the `TRILIUM_ELECTRON_DATA_DIR` environment variable to an explicit path. The `trilium-portable` script does this automatically, pointing it to `trilium-electron-data/` next to the application.
## 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:
@@ -88,4 +94,5 @@ Apart from the data directory, some of the subdirectories of it can be moved els
| `TRILIUM_LOG_DIR` | `${TRILIUM_DATA_DIR}/log` | Directory where daily <a class="reference-link" href="../Troubleshooting/Error%20logs/Backend%20(server)%20logs.md">Backend (server) logs</a> are stored. |
| `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 <a class="reference-link" href="../Troubleshooting/Anonymized%20Database.md">Anonymized Database</a> is stored. |
| `TRILIUM_CONFIG_INI_PATH` | `${TRILIUM_DATA_DIR}/config.ini` | Path to <a class="reference-link" href="../Advanced%20Usage/Configuration%20(config.ini%20or%20e.md">Configuration (config.ini or environment variables)</a> file. |
| `TRILIUM_CONFIG_INI_PATH` | `${TRILIUM_DATA_DIR}/config.ini` | Path to <a class="reference-link" href="../Advanced%20Usage/Configuration%20(config.ini%20or%20e.md">Configuration (config.ini or environment variables)</a> file. |
| `TRILIUM_ELECTRON_DATA_DIR` | System appData | Directory for Electron internal data (caches, spell-check dictionaries, etc.). Set this in portable mode to avoid writing to the system profile (desktop only). |

View File

@@ -11,7 +11,7 @@ Trilium offers various startup scripts to customize your experience:
* `trilium-no-cert-check`: Starts Trilium without validating [TLS certificates](Server%20Installation/HTTPS%20\(TLS\).md), useful if connecting to a server with a self-signed certificate.
* Alternatively, set the `NODE_TLS_REJECT_UNAUTHORIZED=0` environment variable before starting Trilium.
* `trilium-portable`: Launches Trilium in portable mode, where the [data directory](Data%20directory.md) is created within the application's directory, making it easy to move the entire setup.
* `trilium-portable`: Launches Trilium in portable mode, where the [data directory](Data%20directory.md) is created within the application's directory, making it easy to move the 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.
## Synchronization

View File

@@ -0,0 +1,237 @@
# License
GNU AFFERO GENERAL PUBLIC LICENSE
Version 3, 19 November 2007
Copyright (C) 2007 Free Software Foundation, Inc. [https://fsf.org/](https://fsf.org/)
Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.
## Preamble
The GNU Affero General Public License is a free, copyleft license for software and other kinds of works, specifically designed to ensure cooperation with the community in the case of network server software.
The licenses for most software and other practical works are designed to take away your freedom to share and change the works. By contrast, our General Public Licenses are intended to guarantee your freedom to share and change all versions of a program--to make sure it remains free software for all its users.
When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for them if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs, and that you know you can do these things.
Developers that use our General Public Licenses protect your rights with two steps: (1) assert copyright on the software, and (2) offer you this License which gives you legal permission to copy, distribute and/or modify the software.
A secondary benefit of defending all users' freedom is that improvements made in alternate versions of the program, if they receive widespread use, become available for other developers to incorporate. Many developers of free software are heartened and encouraged by the resulting cooperation. However, in the case of software used on network servers, this result may fail to come about. The GNU General Public License permits making a modified version and letting the public access it on a server without ever releasing its source code to the public.
The GNU Affero General Public License is designed specifically to ensure that, in such cases, the modified source code becomes available to the community. It requires the operator of a network server to provide the source code of the modified version running there to the users of that server. Therefore, public use of a modified version, on a publicly accessible server, gives the public access to the source code of the modified version.
An older license, called the Affero General Public License and published by Affero, was designed to accomplish similar goals. This is a different license, not a version of the Affero GPL, but Affero has released a new version of the Affero GPL which permits relicensing under this license.
The precise terms and conditions for copying, distribution and modification follow.
## TERMS AND CONDITIONS
### 0\. Definitions.
"This License" refers to version 3 of the GNU Affero General Public License.
"Copyright" also means copyright-like laws that apply to other kinds of works, such as semiconductor masks.
"The Program" refers to any copyrightable work licensed under this License. Each licensee is addressed as "you". "Licensees" and "recipients" may be individuals or organizations.
To "modify" a work means to copy from or adapt all or part of the work in a fashion requiring copyright permission, other than the making of an exact copy. The resulting work is called a "modified version" of the earlier work or a work "based on" the earlier work.
A "covered work" means either the unmodified Program or a work based on the Program.
To "propagate" a work means to do anything with it that, without permission, would make you directly or secondarily liable for infringement under applicable copyright law, except executing it on a computer or modifying a private copy. Propagation includes copying, distribution (with or without modification), making available to the public, and in some countries other activities as well.
To "convey" a work means any kind of propagation that enables other parties to make or receive copies. Mere interaction with a user through a computer network, with no transfer of a copy, is not conveying.
An interactive user interface displays "Appropriate Legal Notices" to the extent that it includes a convenient and prominently visible feature that (1) displays an appropriate copyright notice, and (2) tells the user that there is no warranty for the work (except to the extent that warranties are provided), that licensees may convey the work under this License, and how to view a copy of this License. If the interface presents a list of user commands or options, such as a menu, a prominent item in the list meets this criterion.
### 1\. Source Code.
The "source code" for a work means the preferred form of the work for making modifications to it. "Object code" means any non-source form of a work.
A "Standard Interface" means an interface that either is an official standard defined by a recognized standards body, or, in the case of interfaces specified for a particular programming language, one that is widely used among developers working in that language.
The "System Libraries" of an executable work include anything, other than the work as a whole, that (a) is included in the normal form of packaging a Major Component, but which is not part of that Major Component, and (b) serves only to enable use of the work with that Major Component, or to implement a Standard Interface for which an implementation is available to the public in source code form. A "Major Component", in this context, means a major essential component (kernel, window system, and so on) of the specific operating system (if any) on which the executable work runs, or a compiler used to produce the work, or an object code interpreter used to run it.
The "Corresponding Source" for a work in object code form means all the source code needed to generate, install, and (for an executable work) run the object code and to modify the work, including scripts to control those activities. However, it does not include the work's System Libraries, or general-purpose tools or generally available free programs which are used unmodified in performing those activities but which are not part of the work. For example, Corresponding Source includes interface definition files associated with source files for the work, and the source code for shared libraries and dynamically linked subprograms that the work is specifically designed to require, such as by intimate data communication or control flow between those subprograms and other parts of the work.
The Corresponding Source need not include anything that users can regenerate automatically from other parts of the Corresponding Source.
The Corresponding Source for a work in source code form is that same work.
### 2\. Basic Permissions.
All rights granted under this License are granted for the term of copyright on the Program, and are irrevocable provided the stated conditions are met. This License explicitly affirms your unlimited permission to run the unmodified Program. The output from running a covered work is covered by this License only if the output, given its content, constitutes a covered work. This License acknowledges your rights of fair use or other equivalent, as provided by copyright law.
You may make, run and propagate covered works that you do not convey, without conditions so long as your license otherwise remains in force. You may convey covered works to others for the sole purpose of having them make modifications exclusively for you, or provide you with facilities for running those works, provided that you comply with the terms of this License in conveying all material for which you do not control copyright. Those thus making or running the covered works for you must do so exclusively on your behalf, under your direction and control, on terms that prohibit them from making any copies of your copyrighted material outside their relationship with you.
Conveying under any other circumstances is permitted solely under the conditions stated below. Sublicensing is not allowed; section 10 makes it unnecessary.
### 3\. Protecting Users' Legal Rights From Anti-Circumvention Law.
No covered work shall be deemed part of an effective technological measure under any applicable law fulfilling obligations under article 11 of the WIPO copyright treaty adopted on 20 December 1996, or similar laws prohibiting or restricting circumvention of such measures.
When you convey a covered work, you waive any legal power to forbid circumvention of technological measures to the extent such circumvention is effected by exercising rights under this License with respect to the covered work, and you disclaim any intention to limit operation or modification of the work as a means of enforcing, against the work's users, your or third parties' legal rights to forbid circumvention of technological measures.
### 4\. Conveying Verbatim Copies.
You may convey verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice; keep intact all notices stating that this License and any non-permissive terms added in accord with section 7 apply to the code; keep intact all notices of the absence of any warranty; and give all recipients a copy of this License along with the Program.
You may charge any price or no price for each copy that you convey, and you may offer support or warranty protection for a fee.
### 5\. Conveying Modified Source Versions.
You may convey a work based on the Program, or the modifications to produce it from the Program, in the form of source code under the terms of section 4, provided that you also meet all of these conditions:
* a) The work must carry prominent notices stating that you modified it, and giving a relevant date.
* b) The work must carry prominent notices stating that it is released under this License and any conditions added under section 7. This requirement modifies the requirement in section 4 to "keep intact all notices".
* c) You must license the entire work, as a whole, under this License to anyone who comes into possession of a copy. This License will therefore apply, along with any applicable section 7 additional terms, to the whole of the work, and all its parts, regardless of how they are packaged. This License gives no permission to license the work in any other way, but it does not invalidate such permission if you have separately received it.
* d) If the work has interactive user interfaces, each must display Appropriate Legal Notices; however, if the Program has interactive interfaces that do not display Appropriate Legal Notices, your work need not make them do so.
A compilation of a covered work with other separate and independent works, which are not by their nature extensions of the covered work, and which are not combined with it such as to form a larger program, in or on a volume of a storage or distribution medium, is called an "aggregate" if the compilation and its resulting copyright are not used to limit the access or legal rights of the compilation's users beyond what the individual works permit. Inclusion of a covered work in an aggregate does not cause this License to apply to the other parts of the aggregate.
### 6\. Conveying Non-Source Forms.
You may convey a covered work in object code form under the terms of sections 4 and 5, provided that you also convey the machine-readable Corresponding Source under the terms of this License, in one of these ways:
* a) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by the Corresponding Source fixed on a durable physical medium customarily used for software interchange.
* b) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by a written offer, valid for at least three years and valid for as long as you offer spare parts or customer support for that product model, to give anyone who possesses the object code either (1) a copy of the Corresponding Source for all the software in the product that is covered by this License, on a durable physical medium customarily used for software interchange, for a price no more than your reasonable cost of physically performing this conveying of source, or (2) access to copy the Corresponding Source from a network server at no charge.
* c) Convey individual copies of the object code with a copy of the written offer to provide the Corresponding Source. This alternative is allowed only occasionally and noncommercially, and only if you received the object code with such an offer, in accord with subsection 6b.
* d) Convey the object code by offering access from a designated place (gratis or for a charge), and offer equivalent access to the Corresponding Source in the same way through the same place at no further charge. You need not require recipients to copy the Corresponding Source along with the object code. If the place to copy the object code is a network server, the Corresponding Source may be on a different server (operated by you or a third party) that supports equivalent copying facilities, provided you maintain clear directions next to the object code saying where to find the Corresponding Source. Regardless of what server hosts the Corresponding Source, you remain obligated to ensure that it is available for as long as needed to satisfy these requirements.
* e) Convey the object code using peer-to-peer transmission, provided you inform other peers where the object code and Corresponding Source of the work are being offered to the general public at no charge under subsection 6d.
A separable portion of the object code, whose source code is excluded from the Corresponding Source as a System Library, need not be included in conveying the object code work.
A "User Product" is either (1) a "consumer product", which means any tangible personal property which is normally used for personal, family, or household purposes, or (2) anything designed or sold for incorporation into a dwelling. In determining whether a product is a consumer product, doubtful cases shall be resolved in favor of coverage. For a particular product received by a particular user, "normally used" refers to a typical or common use of that class of product, regardless of the status of the particular user or of the way in which the particular user actually uses, or expects or is expected to use, the product. A product is a consumer product regardless of whether the product has substantial commercial, industrial or non-consumer uses, unless such uses represent the only significant mode of use of the product.
"Installation Information" for a User Product means any methods, procedures, authorization keys, or other information required to install and execute modified versions of a covered work in that User Product from a modified version of its Corresponding Source. The information must suffice to ensure that the continued functioning of the modified object code is in no case prevented or interfered with solely because modification has been made.
If you convey an object code work under this section in, or with, or specifically for use in, a User Product, and the conveying occurs as part of a transaction in which the right of possession and use of the User Product is transferred to the recipient in perpetuity or for a fixed term (regardless of how the transaction is characterized), the Corresponding Source conveyed under this section must be accompanied by the Installation Information. But this requirement does not apply if neither you nor any third party retains the ability to install modified object code on the User Product (for example, the work has been installed in ROM).
The requirement to provide Installation Information does not include a requirement to continue to provide support service, warranty, or updates for a work that has been modified or installed by the recipient, or for the User Product in which it has been modified or installed. Access to a network may be denied when the modification itself materially and adversely affects the operation of the network or violates the rules and protocols for communication across the network.
Corresponding Source conveyed, and Installation Information provided, in accord with this section must be in a format that is publicly documented (and with an implementation available to the public in source code form), and must require no special password or key for unpacking, reading or copying.
### 7\. Additional Terms.
"Additional permissions" are terms that supplement the terms of this License by making exceptions from one or more of its conditions. Additional permissions that are applicable to the entire Program shall be treated as though they were included in this License, to the extent that they are valid under applicable law. If additional permissions apply only to part of the Program, that part may be used separately under those permissions, but the entire Program remains governed by this License without regard to the additional permissions.
When you convey a copy of a covered work, you may at your option remove any additional permissions from that copy, or from any part of it. (Additional permissions may be written to require their own removal in certain cases when you modify the work.) You may place additional permissions on material, added by you to a covered work, for which you have or can give appropriate copyright permission.
Notwithstanding any other provision of this License, for material you add to a covered work, you may (if authorized by the copyright holders of that material) supplement the terms of this License with terms:
* a) Disclaiming warranty or limiting liability differently from the terms of sections 15 and 16 of this License; or
* b) Requiring preservation of specified reasonable legal notices or author attributions in that material or in the Appropriate Legal Notices displayed by works containing it; or
* c) Prohibiting misrepresentation of the origin of that material, or requiring that modified versions of such material be marked in reasonable ways as different from the original version; or
* d) Limiting the use for publicity purposes of names of licensors or authors of the material; or
* e) Declining to grant rights under trademark law for use of some trade names, trademarks, or service marks; or
* f) Requiring indemnification of licensors and authors of that material by anyone who conveys the material (or modified versions of it) with contractual assumptions of liability to the recipient, for any liability that these contractual assumptions directly impose on those licensors and authors.
All other non-permissive additional terms are considered "further restrictions" within the meaning of section 10. If the Program as you received it, or any part of it, contains a notice stating that it is governed by this License along with a term that is a further restriction, you may remove that term. If a license document contains a further restriction but permits relicensing or conveying under this License, you may add to a covered work material governed by the terms of that license document, provided that the further restriction does not survive such relicensing or conveying.
If you add terms to a covered work in accord with this section, you must place, in the relevant source files, a statement of the additional terms that apply to those files, or a notice indicating where to find the applicable terms.
Additional terms, permissive or non-permissive, may be stated in the form of a separately written license, or stated as exceptions; the above requirements apply either way.
### 8\. Termination.
You may not propagate or modify a covered work except as expressly provided under this License. Any attempt otherwise to propagate or modify it is void, and will automatically terminate your rights under this License (including any patent licenses granted under the third paragraph of section 11).
However, if you cease all violation of this License, then your license from a particular copyright holder is reinstated (a) provisionally, unless and until the copyright holder explicitly and finally terminates your license, and (b) permanently, if the copyright holder fails to notify you of the violation by some reasonable means prior to 60 days after the cessation.
Moreover, your license from a particular copyright holder is reinstated permanently if the copyright holder notifies you of the violation by some reasonable means, this is the first time you have received notice of violation of this License (for any work) from that copyright holder, and you cure the violation prior to 30 days after your receipt of the notice.
Termination of your rights under this section does not terminate the licenses of parties who have received copies or rights from you under this License. If your rights have been terminated and not permanently reinstated, you do not qualify to receive new licenses for the same material under section 10.
### 9\. Acceptance Not Required for Having Copies.
You are not required to accept this License in order to receive or run a copy of the Program. Ancillary propagation of a covered work occurring solely as a consequence of using peer-to-peer transmission to receive a copy likewise does not require acceptance. However, nothing other than this License grants you permission to propagate or modify any covered work. These actions infringe copyright if you do not accept this License. Therefore, by modifying or propagating a covered work, you indicate your acceptance of this License to do so.
### 10\. Automatic Licensing of Downstream Recipients.
Each time you convey a covered work, the recipient automatically receives a license from the original licensors, to run, modify and propagate that work, subject to this License. You are not responsible for enforcing compliance by third parties with this License.
An "entity transaction" is a transaction transferring control of an organization, or substantially all assets of one, or subdividing an organization, or merging organizations. If propagation of a covered work results from an entity transaction, each party to that transaction who receives a copy of the work also receives whatever licenses to the work the party's predecessor in interest had or could give under the previous paragraph, plus a right to possession of the Corresponding Source of the work from the predecessor in interest, if the predecessor has it or can get it with reasonable efforts.
You may not impose any further restrictions on the exercise of the rights granted or affirmed under this License. For example, you may not impose a license fee, royalty, or other charge for exercise of rights granted under this License, and you may not initiate litigation (including a cross-claim or counterclaim in a lawsuit) alleging that any patent claim is infringed by making, using, selling, offering for sale, or importing the Program or any portion of it.
### 11\. Patents.
A "contributor" is a copyright holder who authorizes use under this License of the Program or a work on which the Program is based. The work thus licensed is called the contributor's "contributor version".
A contributor's "essential patent claims" are all patent claims owned or controlled by the contributor, whether already acquired or hereafter acquired, that would be infringed by some manner, permitted by this License, of making, using, or selling its contributor version, but do not include claims that would be infringed only as a consequence of further modification of the contributor version. For purposes of this definition, "control" includes the right to grant patent sublicenses in a manner consistent with the requirements of this License.
Each contributor grants you a non-exclusive, worldwide, royalty-free patent license under the contributor's essential patent claims, to make, use, sell, offer for sale, import and otherwise run, modify and propagate the contents of its contributor version.
In the following three paragraphs, a "patent license" is any express agreement or commitment, however denominated, not to enforce a patent (such as an express permission to practice a patent or covenant not to sue for patent infringement). To "grant" such a patent license to a party means to make such an agreement or commitment not to enforce a patent against the party.
If you convey a covered work, knowingly relying on a patent license, and the Corresponding Source of the work is not available for anyone to copy, free of charge and under the terms of this License, through a publicly available network server or other readily accessible means, then you must either (1) cause the Corresponding Source to be so available, or (2) arrange to deprive yourself of the benefit of the patent license for this particular work, or (3) arrange, in a manner consistent with the requirements of this License, to extend the patent license to downstream recipients. "Knowingly relying" means you have actual knowledge that, but for the patent license, your conveying the covered work in a country, or your recipient's use of the covered work in a country, would infringe one or more identifiable patents in that country that you have reason to believe are valid.
If, pursuant to or in connection with a single transaction or arrangement, you convey, or propagate by procuring conveyance of, a covered work, and grant a patent license to some of the parties receiving the covered work authorizing them to use, propagate, modify or convey a specific copy of the covered work, then the patent license you grant is automatically extended to all recipients of the covered work and works based on it.
A patent license is "discriminatory" if it does not include within the scope of its coverage, prohibits the exercise of, or is conditioned on the non-exercise of one or more of the rights that are specifically granted under this License. You may not convey a covered work if you are a party to an arrangement with a third party that is in the business of distributing software, under which you make payment to the third party based on the extent of your activity of conveying the work, and under which the third party grants, to any of the parties who would receive the covered work from you, a discriminatory patent license (a) in connection with copies of the covered work conveyed by you (or copies made from those copies), or (b) primarily for and in connection with specific products or compilations that contain the covered work, unless you entered into that arrangement, or that patent license was granted, prior to 28 March 2007.
Nothing in this License shall be construed as excluding or limiting any implied license or other defenses to infringement that may otherwise be available to you under applicable patent law.
### 12\. No Surrender of Others' Freedom.
If conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot convey a covered work so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not convey it at all. For example, if you agree to terms that obligate you to collect a royalty for further conveying from those to whom you convey the Program, the only way you could satisfy both those terms and this License would be to refrain entirely from conveying the Program.
### 13\. Remote Network Interaction; Use with the GNU General Public License.
Notwithstanding any other provision of this License, if you modify the Program, your modified version must prominently offer all users interacting with it remotely through a computer network (if your version supports such interaction) an opportunity to receive the Corresponding Source of your version by providing access to the Corresponding Source from a network server at no charge, through some standard or customary means of facilitating copying of software. This Corresponding Source shall include the Corresponding Source for any work covered by version 3 of the GNU General Public License that is incorporated pursuant to the following paragraph.
Notwithstanding any other provision of this License, you have permission to link or combine any covered work with a work licensed under version 3 of the GNU General Public License into a single combined work, and to convey the resulting work. The terms of this License will continue to apply to the part which is the covered work, but the work with which it is combined will remain governed by version 3 of the GNU General Public License.
### 14\. Revised Versions of this License.
The Free Software Foundation may publish revised and/or new versions of the GNU Affero General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns.
Each version is given a distinguishing version number. If the Program specifies that a certain numbered version of the GNU Affero General Public License "or any later version" applies to it, you have the option of following the terms and conditions either of that numbered version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of the GNU Affero General Public License, you may choose any version ever published by the Free Software Foundation.
If the Program specifies that a proxy can decide which future versions of the GNU Affero General Public License can be used, that proxy's public statement of acceptance of a version permanently authorizes you to choose that version for the Program.
Later license versions may give you additional or different permissions. However, no additional obligations are imposed on any author or copyright holder as a result of your choosing to follow a later version.
### 15\. Disclaimer of Warranty.
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
### 16\. Limitation of Liability.
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
### 17\. Interpretation of Sections 15 and 16.
If the disclaimer of warranty and limitation of liability provided above cannot be given local legal effect according to their terms, reviewing courts shall apply local law that most closely approximates an absolute waiver of all civil liability in connection with the Program, unless a warranty or assumption of liability accompanies a copy of the Program in return for a fee.
END OF TERMS AND CONDITIONS
## How to Apply These Terms to Your New Programs
If you develop a new program, and you want it to be of the greatest possible use to the public, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms.
To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively state the exclusion of warranty; and each file should have at least the "copyright" line and a pointer to where the full notice is found.
```
<one line to give the program's name and a brief idea of what it does.>
Copyright (C) <year> <name of author>
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as
published by the Free Software Foundation, either version 3 of the
License, or (at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>.
```
Also add information on how to contact you by electronic and paper mail.
If your software can interact with users remotely through a computer network, you should also make sure that it provides a way for users to get its source. For example, if your program is a web application, its interface could display a "Source" link that leads users to an archive of the code. There are many ways you could offer source, and different solutions will be better for different programs; see section 13 for the specific requirements.
You should also get your employer (if you work as a programmer) or school, if any, to sign a "copyright disclaimer" for the program, if necessary. For more information on this, and how to apply and follow the GNU AGPL, see [https://www.gnu.org/licenses/](https://www.gnu.org/licenses/).

View File

@@ -33,7 +33,7 @@ The following note types are supported by Trilium:
| <a class="reference-link" href="Note%20Types/Relation%20Map.md">Relation Map</a> | Allows easy creation of notes and relations between them. Can be used for mainly relational data such as a family tree. |
| <a class="reference-link" href="Note%20Types/Note%20Map.md">Note Map</a> | Displays the relationships between the notes, whether via relations or their hierarchical structure. |
| <a class="reference-link" href="Note%20Types/Render%20Note.md">Render Note</a> | Used in <a class="reference-link" href="Scripting.md">Scripting</a>, 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. |
| <a class="reference-link" href="Collections.md">Collections</a> | Displays the children of the note either as a grid, a list, or for a more specialized case: a calendar.  <br> <br>Generally useful for easy reading of short notes. |
| <a class="reference-link" href="Collections.md">Collections</a> | Displays the children of the note either as a grid, a list, or for a more specialized case: a calendar.   <br> <br>Generally useful for easy reading of short notes. |
| <a class="reference-link" href="Note%20Types/Mermaid%20Diagrams.md">Mermaid Diagrams</a> | 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. |
| <a class="reference-link" href="Note%20Types/Canvas.md">Canvas</a> | Allows easy drawing of sketches, diagrams, handwritten content. Uses the same technology behind [excalidraw.com](https://excalidraw.com). |
| <a class="reference-link" href="Note%20Types/Web%20View.md">Web View</a> | Displays the content of an external web page, similar to a browser. |

View File

@@ -26,6 +26,37 @@ Note that the list of languages is not immediately refreshed, you'd have to manu
The list of languages is also shared with the [Code blocks](Text/Developer-specific%20formatting/Code%20blocks.md) feature of [Text](Text.md) notes.
## Word wrap
Long lines can be displayed on multiple lines:
* Globally for all code notes, from <a class="reference-link" href="../Basic%20Concepts%20and%20Features/UI%20Elements/Options.md">Options</a> → _Code Notes._
* For a particular note, by going to the menu in <a class="reference-link" href="../Basic%20Concepts%20and%20Features/UI%20Elements/Note%20buttons.md">Note buttons</a> and selecting _Word wrap_ and selecting the appropriate option:
* _Auto_, to respect the global word wrap for code notes.
* _On_ or _Off_, to change the state of the word wrap for this note regardless of the global option.
## Adjusting options using the status bar
> [!NOTE]
> This feature is only available for the <a class="reference-link" href="../Basic%20Concepts%20and%20Features/UI%20Elements/New%20Layout.md">New Layout</a>. For the old layout, the tab width can be adjusted at note level using the `#tabWidth` attribute, but re-indentation is not available.
The status bar at the bottom of the editor shows the current indentation settings and language. Clicking on the indentation indicator opens a menu with three sections:
1. **Indent Using** — switch between Spaces and Tabs. If a per-note override is active, a "Reset to default" option appears.
2. **Display Width** — choose from preset widths (1, 2, 3, 4, 6, 8). Changes are saved as a per-note `#tabWidth` label.
3. **Re-indent Content To** — convert existing indentation to a different style. For example, re-indent a file from 4 spaces to 2 spaces, or from spaces to tabs. This rewrites the leading whitespace on every line while preserving alignment remainders.
Clicking the language indicator lets you change the note's MIME type.
### Re-indentation
When you re-indent content, the editor:
* Measures the visual column width of each line's leading whitespace using the current style
* Calculates indent levels and any alignment remainder
* Rebuilds the leading whitespace in the target style
* Preserves non-leading whitespace, blank lines, and content without indentation
## Color schemes
Since Trilium 0.94.0 the colors of code notes can be customized by going <a class="reference-link" href="../Basic%20Concepts%20and%20Features/UI%20Elements/Options.md">Options</a> → Code Notes and looking for the _Appearance_ section.

View File

@@ -0,0 +1,92 @@
# Markdown
Trilium has always supported Markdown through its [import feature](../Basic%20Concepts%20and%20Features/Import%20%26%20Export/Markdown.md), however the file was either transformed to a <a class="reference-link" href="Text.md">Text</a> note (converted to Trilium's internal HTML format) or saved as a <a class="reference-link" href="Code.md">Code</a> 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 <a class="reference-link" href="../Basic%20Concepts%20and%20Features/UI%20Elements/Note%20types%20with%20split%20view.md">Note types with split view</a> 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 otherwise through import/export.
Even if Markdown is now specially treated by having a preview mechanism, Trilium remains at its core a WYSWYG editor so Markdown will not replace text notes.
> [!NOTE]
> Feature requests regarding the Markdown implementation will be considered, but if they are outside the realm of Trilium they will not be implemented. One of the core aspects of the Markdown integration is that it reuses components that are already available through other features of the application.
## Features
### Source view pane
* Syntax highlighting for the Markdown syntax.
* Nested syntax highlighting for code inside code blocks.
* When editing larger documents, the preview scrolls along with the source editor.
### Preview pane
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
* <a class="reference-link" href="Text/Block%20quotes%20%26%20admonitions.md">Block quotes &amp; admonitions</a>
* <a class="reference-link" href="Text/Math%20Equations.md">Math Equations</a>
* <a class="reference-link" href="Mermaid%20Diagrams.md">Mermaid Diagrams</a> using ` ```mermaid `
* <a class="reference-link" href="Text/Include%20Note.md">Include Note</a> (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
```
* <a class="reference-link" href="Text/Links/Internal%20(reference)%20links.md">Internal (reference) links</a> via its HTML syntax, or through a _Wikilinks_\-like format (only <a class="reference-link" href="../Advanced%20Usage/Note%20ID.md">Note ID</a>):
```
[[Hg8TS5ZOxti6]]
```
## Creating Markdown notes
There are two ways to create a Markdown note:
1. Create a new note (e.g. in the <a class="reference-link" href="../Basic%20Concepts%20and%20Features/UI%20Elements/Note%20Tree.md">Note Tree</a>) and select the type _Markdown_, just like all the other note types.
2. Create a note of type <a class="reference-link" href="Code.md">Code</a> 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.
> [!NOTE]
> There is no distinction between the new Markdown note type and code notes of type Markdown; internally both are represented as <a class="reference-link" href="Code.md">Code</a> notes with the proper MIME type (e.g. `text/x-markdown`).
## Import/export
* By default, when importing a single Markdown file it automatically gets converted to a <a class="reference-link" href="Text.md">Text</a> note. To avoid that and have it imported as a Markdown note instead:
* Right click the <a class="reference-link" href="../Basic%20Concepts%20and%20Features/UI%20Elements/Note%20Tree.md">Note Tree</a> 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_.
* When exporting Markdown files, the extension is preserved and the content remains the same as in the source view.
* Once exported as a Trilium ZIP, the ZIP will preserve the Markdown type without converting to text notes thanks to the meta-information in it.
## Conversion between text notes and Markdown notes
Currently there is no built-in functionality to convert a <a class="reference-link" href="Text.md">Text</a> 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. Import the file again, but unchecking _Import HTML, Markdown and TXT as text notes if it's unclear from the metadata_.
For multiple notes, the process is slightly more involved:
1. Export the file as Markdown, ZIP.
2. Extract the archive.
3. Remove the `!!!meta.json` file.
4. Compress the extracted files back into an archive.
5. Import the newly create archive, but unchecking _Import HTML, Markdown and TXT as text notes if it's unclear from the metadata_.
## Sync-scrolling & block highlight
When scrolling through the editing pane, the preview pane will attempt to synchronize its position to make it easier to see the preview.
In addition, the block in the preview matching the position of the cursor in the source view will appear slightly highlighted.
The sync is currently one-way only, scrolling the preview will not synchronize the position of the editor.
This feature cannot be disabled as of now; if the scrolling feels distracting, consider temporarily switching to the editor mode and then switching to preview mode when ready.
> [!NOTE]
> 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](../Troubleshooting/Reporting%20issues.md), but always provide a sample Markdown file to be able to reproduce it.

View File

@@ -4,10 +4,12 @@
<figure class="image image-style-align-center"><img style="aspect-ratio:886/663;" src="2_Mermaid Diagrams_image.png" width="886" height="663"></figure>
## Types of diagrams
Trilium supports Mermaid, which adds support for various diagrams such as flowchart, sequence diagram, class diagram, state diagram, pie charts, etc., all using a text description of the chart instead of manually drawing 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 <a class="reference-link" href="../Basic%20Concepts%20and%20Features/UI%20Elements/Note%20types%20with%20split%20view.md">Note types with split view</a> 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 diagrams with sample code for each:
* Simply click on any of the samples to apply it.

View File

@@ -69,4 +69,4 @@ It's possible to refresh the note via:
## Examples
* <a class="reference-link" href="../Advanced%20Usage/Advanced%20Showcases/Weight%20Tracker.md">Weight Tracker</a> which is present in the <a class="reference-link" href="../Advanced%20Usage/Database/Demo%20Notes.md">Demo Notes</a>.
* <a class="reference-link" href="../Advanced%20Usage/Advanced%20Showcases/Weight%20Tracker.md">[missing note]</a> which is present in the <a class="reference-link" href="../Advanced%20Usage/Database/Demo%20Notes.md">[missing note]</a>.

View File

@@ -60,7 +60,6 @@ If you would like us to work on these features, consider [supporting us](https:/
## Known limitations
* It is possible to share a spreadsheet, case in which a best-effort HTML rendering of the spreadsheet is done.
* For more advanced use cases, this will most likely not work as intended. Feel free to [report issues](../Troubleshooting/Reporting%20issues.md), but keep in mind that we might not be able to have a complete feature parity with all the features of Univer.
* There is currently no export functionality, as stated previously.
* 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.

View File

Before

Width:  |  Height:  |  Size: 703 B

After

Width:  |  Height:  |  Size: 703 B

View File

@@ -0,0 +1,46 @@
# Anchors
> [!NOTE]
> This feature used to be called _Bookmarks_ (as it is the official name in the editor we are using), but in order not to collide with the concept of <a class="reference-link" href="../../Basic%20Concepts%20and%20Features/Navigation/Bookmarks.md">Bookmarks</a>, we have renamed it to _Anchors._
Anchors allows creating [links](Links.md) to a certain part of a note, such as referencing a particular heading or section within a note.
This feature was introduced in TriliumNext v0.94.0 and augmented in v0.130.0 to support linking across notes.
## Interaction
* To create a anchor:
* Place the cursor at the desired position where to place the anchor.
* Look for the <img src="Anchors_plus.png" width="15" height="16"> button in the <a class="reference-link" href="Formatting%20toolbar.md">Formatting toolbar</a>, and then press the <img src="1_Anchors_plus.png" width="12" height="15"> button.
* Alternatively, use <a class="reference-link" href="Premium%20features/Slash%20Commands.md">Slash Commands</a> and look for _anchor_.
* To place a link to a anchor:
* Place the cursor at the desired position of the link.
* From the [link](Links.md) pane, select the _Anchors_ section and select the desired anchor.
## Linking across notes
Trilium v0.103.0 introduces cross-note Anchors, which makes it possible to create <a class="reference-link" href="Links/Internal%20(reference)%20links.md">Internal (reference) links</a> which point to a specific anchor in that document.
### Compatibility with documents from previous versions
For notes created prior to Trilium v0.103.0, you might notice that the Anchors might not be identified. This limitation is intentional in order not to have to re-process all the notes, looking for anchors.
To fix this, simply go that note and make any change (e.g. inserting a space), this will trigger the recalculation of the links.
### Linking to anchors through the _Add link_ dialog
1. Create an anchor in the target note using the same process as described above.
2. In another note, press <kbd>Ctrl</kbd>+<kbd>L</kbd> to insert an internal link. Select the target note containing Anchors.
3. If the target note contains Anchors, a section will appear underneath the note selector with the list of Anchors.
4. Add the link normally.
Clicking on a reference link pointing to a anchor will automatically scroll to the desired section.
### Linking to anchors through the bookmark toolbar
1. Create an anchor in the target note using the same process as described above.
2. Click on the anchor to reveal the anchor's floating toolbar.
3. Click on the _Copy anchor reference link_ button.
4. Go to the note where to insert the link and press <kbd>Ctrl</kbd>+<kbd>V</kbd>.
> [!NOTE]
> Use this method only to insert <a class="reference-link" href="Links/Internal%20(reference)%20links.md">Internal (reference) links</a> between two documents. To link to an anchor on the same note, use the _Insert link_ dialog (<kbd>Ctrl</kbd>+<kbd>K</kbd>) and select the _Anchors_ item instead.

View File

Before

Width:  |  Height:  |  Size: 636 B

After

Width:  |  Height:  |  Size: 636 B

View File

@@ -1,19 +0,0 @@
# Bookmarks
Bookmarks allows creating [links](Links.md) to a certain part of a note, such as referencing a particular heading.
Technically, bookmarks are HTML anchors.
This feature was introduced in TriliumNext 0.94.0.
## Interaction
* To create a bookmark:
* Place the cursor at the desired position where to place the bookmark.
* Look for the <img src="Bookmarks_plus.png" width="15" height="16"> button in the <a class="reference-link" href="Formatting%20toolbar.md">Formatting toolbar</a>, and then press the <img src="1_Bookmarks_plus.png" width="12" height="15"> button.
* To place a link to a bookmark:
* Place the cursor at the desired position of the link.
* From the [link](Links.md) pane, select the _Bookmarks_ section and select the desired bookmark.
## Limitations
* Currently it's not possible to create a link to a bookmark from a different note. This functionality will be added after the internal links feature is enhanced to support bookmarks.

View File

@@ -36,6 +36,7 @@ In order to configure this new feature, a section has been added in Options →
* It is possible to disable the syntax highlighting for all the notes by selecting “No syntax highlighting” in the “Color scheme” option.
* Word wrapping is disabled by default, but can be configured from the same section.
* The tab width can also be adjusted from Options.
> [!NOTE]
> **Context regarding syntax highlighting**

View File

@@ -3,7 +3,7 @@ Press the <img src="4_Insert buttons_image.png" width="34" height="16"> button i
## Bookmarks
See the dedicated <a class="reference-link" href="Bookmarks.md">Bookmarks</a> section.
See the dedicated <a class="reference-link" href="Anchors.md">Anchors</a> section.
## Emoji