gaschz/trilium
1
0
Fork 0
mirror of https://github.com/zadam/trilium.git synced 2025-03-01 14:22:32 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity

Updated Text editor (markdown)

zadam 2020-04-07 21:33:32 +02:00
parent 12b66d92ef
commit 00ae2ad34b
1 changed files with 11 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
Text-editor.md → Text-notes.md

@ -1,11 +1,20 @@
Trilium uses awesome [CKEditor 5](https://ckeditor.com/ckeditor-5/) as its editing component.
## Read only vs. editing mode
Text notes are normally opened in edit mode, however there are two cases when they are open in read only mode:
* they are long and thus would take time to load so by default we open them as read only which is much quicker
* or the note has `readOnly` [[label|attributes]]
In both cases it is possible to switch to editable mode again.
## Autoformat
CKEditor supports markdown-like editing experience. It recognizes syntax and automatically converts it to rich text. See it in action:
[[gifs/autoformat.gif]]
ode
Complete documentation for this feature is available in [CKEditor documentation](https://ckeditor.com/docs/ckeditor5/latest/features/autoformat.html).
If the autoformat is not desirable for what you just wrote, you can press `CTRL-Z` which will un-autoformat the text to its original form.
@ -32,8 +41,4 @@ It is also possible to assign a keyboard shortcut for this action.
Text notes can "include" another note as a read only widget. This can be useful for e.g. including a dynamically generated chart (from scripts & "render HTML" note) or other more advanced use cases.
This functionality is available in the block toolbar icon.
## Read only mode
To prevent accidental changes you can put text editor into read only mode by attaching `readOnly` [[label|Attributes]].
This functionality is available in the block toolbar icon.