mirror of
https://github.com/TriliumNext/Notes.git
synced 2025-09-22 04:01:38 +08:00
fix(docs): use LF instead of CRLF
This commit is contained in:
Elian Doran
parent
4b8e3b39fe
commit
749a398128
@ -35,7 +35,7 @@ Basic Auth is meant to be used with tools which support only basic auth.
|
||||
|
||||
It is possible to write simple Bash scripts to interact with Trilium. As an example, here's how to obtain the HTML content of a note:
|
||||
|
||||
```sh
|
||||
```
|
||||
#!/usr/bin/env bash
|
||||
|
||||
# Configuration
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
# Note Map (Link map, Tree map)
|
||||
# Note Map (Link map, Tree map)
|
||||
Note map is a visualisation of connections between notes.
|
||||
|
||||
This provides an insight into a structure ("web") of notes.
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
# Note source
|
||||
# Note source
|
||||
## Understanding the source code of the different notes
|
||||
|
||||
Internally, the structure of the content of each note is different based on the [Note Types](../Note%20Types).
|
||||
@ -15,7 +15,7 @@ Note that some information is also stored as [Attachments](../Attachments). For
|
||||
|
||||
Here's part of the HTML representation of this note, as it's stored in the database (but prettified).
|
||||
|
||||
```html
|
||||
```
|
||||
<h2>
|
||||
Understanding the source code of the different notes
|
||||
</h2>
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
# Technologies used
|
||||
# Technologies used
|
||||
One core aspect of Trilium that allows it to have support for multiple [Note Types](../Note%20Types) is the fact that it makes use of various off-the-shelf or reusable libraries.
|
||||
|
||||
The sub-pages showcase some of the technologies used, for a better understanding of how Trilium works but also to credit the developers of that particular technology.
|
||||
@ -1,4 +1,4 @@
|
||||
# Excalidraw
|
||||
# Excalidraw
|
||||
[Excalidraw](https://excalidraw.com/) is the technology behind the [Canvas](../../Note%20Types/Canvas.md) notes. The source code of the library is available on [GitHub](https://github.com/excalidraw/excalidraw).
|
||||
|
||||
We are using an unmodified version of it, so it shares the same [issues](https://github.com/excalidraw/excalidraw/issues) as the original.
|
||||
@ -1,4 +1,4 @@
|
||||
# Leaflet
|
||||
# Leaflet
|
||||
Leaflet is the library behind [Geo map](../../Note%20Types/Geo%20map.md) notes.
|
||||
|
||||
## Plugins
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
# MindElixir
|
||||
# MindElixir
|
||||
MindElixir is the library we are using for the [Mind Map](../../Note%20Types/Mind%20Map.md) note types.
|
||||
|
||||
The main library is available on [GitHub as mind-elixir-core](https://github.com/SSShooter/mind-elixir-core/issues).
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
# Evernote
|
||||
# Evernote
|
||||
Trilium can import ENEX files which are used by Evernote for backup/export. One ENEX file represents content (notes and resources) of one notebook.
|
||||
|
||||
## Export ENEX from Evernote
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
# Markdown
|
||||
# Markdown
|
||||
Trilium Notes supports importing Markdown restricted to the [CommonMark specification](https://spec.commonmark.org/current/) (where [tables are not supported](https://github.com/TriliumNext/Notes/issues/2026))
|
||||
|
||||
## Import
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
# OneNote
|
||||
# OneNote
|
||||
**This page describes a method to migrate via EverNote Legacy, but this app is no longer available/working.**
|
||||
|
||||
## Prep Onenote notes for best compatibility
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
# Keyboard Shortcuts
|
||||
# Keyboard Shortcuts
|
||||
This is supposed to be a complete list of keyboard shortcuts. Note that some of these may work only in certain contexts (e.g. in tree pane or note editor).
|
||||
|
||||
It is also possible to configure most keyboard shortcuts in Options -> Keyboard shortcuts. Using `global:` prefix, you can assign a shortcut which will work even without Trilium being in focus (requires app restart to take effect).
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
# Bookmarks
|
||||
# Bookmarks
|
||||
To easily access selected notes, you can bookmark them. See demo:
|
||||
|
||||
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
# Note Hoisting
|
||||
# Note Hoisting
|
||||
Hoisting is a standard outliner feature which allows you to focus on (or "zoom into") a specific note and its subtree by hiding all parent and sibling notes. Demo:
|
||||
|
||||
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
# Note Navigation
|
||||
# Note Navigation
|
||||
One of the Trilium's goals is to provide fast and comfortable navigation between notes.
|
||||
|
||||
## Backwards and forward
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
# Search
|
||||
# Search
|
||||
## Local Search
|
||||
|
||||
Local search allows you to search within the currently displayed note. To initiate a local search, press <kbd>Ctrl</kbd> + <kbd>F</kbd>. If using a web browser, this will be handled by the browser's native search functionality. In the desktop (electron) version, a separate dialog will apear.
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
# Tree Concepts
|
||||
# Tree Concepts
|
||||
This page explains the basic concepts related to the tree structure of notes in TriliumNext.
|
||||
|
||||
## Note
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
# Workspace
|
||||
# Workspace
|
||||
Workspace is a concept built up on top of [note hoisting](Note%20Hoisting.md). It is based on the idea that a user has several distinct spheres of interest. An example might be "Personal" and "Work", these two spheres are quite distinct and don't interact together. When I focus on Work, I don't really care about personal notes.
|
||||
|
||||
So far workspace consists of these features:
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
# Notes
|
||||
# Notes
|
||||
Note is a central entity in Trilium. Main attributes of note are title and content.
|
||||
|
||||
### Note types
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
# Archived Notes
|
||||
# Archived Notes
|
||||
Archived notes are notes which have `archived` [attribute](../../Advanced%20Usage/Attributes.md) - either directly or [inherited](../../Advanced%20Usage/Attributes/Attribute%20Inheritance.md).
|
||||
|
||||
Such notes are then by default not shown in the autocomplete and in the full text [search](../Navigation/Search.md).
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
# Attachments
|
||||
# Attachments
|
||||
A [note](../Notes.md) in Trilium can _own_ one or more attachments, which can be either images or files. These attachments can be displayed or linked within the note that owns them.
|
||||
|
||||
This can be especially useful to include dependencies for your [scripts](../../Note%20Types/Code/Scripts.md). The [Weight Tracker](../../Advanced%20Usage/Advanced%20Showcases/Weight%20Tracker.md) shows how to use [chartjs](https://chartjs.org/) which is attached to the [script note](#root/HcUYTojFohtb).
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
# Cloning Notes
|
||||
# Cloning Notes
|
||||
## Motivation
|
||||
|
||||
Trilium's core feature is the ability to structure your notes into hierarchical tree-like structure.
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
# Export as PDF
|
||||
# Export as PDF
|
||||
|
||||
|
||||
Screenshot of the note contextual menu indicating the “Export as PDF” option.
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
# Note Icons
|
||||
# Note Icons
|
||||
Icons are useful for distinguishing notes. At the technical level, they are set by the `iconClass` attribute which adds a CSS class to the note. For example `#iconClass="bx bx-calendar"` will show a calendar instead of the default page or folder icon. Looking up and remembering the css class names is not necessary. While editing a note, click on the icon next to the title to bring up a chooser gallery:
|
||||
|
||||
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
# Note Revisions
|
||||
# Note Revisions
|
||||
Trilium supports seamless versioning of notes by storing snapshots ("revisions") of notes at regular intervals.
|
||||
|
||||
## Note Revisions Snapshot Interval
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
# Protected Notes
|
||||
# Protected Notes
|
||||
Trilium is designed to store a wide variety of data, including sensitive information such as personal journals, credentials, or confidential documents. To safeguard this type of content, Trilium offers the option to protect notes, which involves the following measures:
|
||||
|
||||
* **Encryption:** Protected notes are encrypted using a key derived from your password. This ensures that without the correct password, protected notes remain indecipherable. Even if someone gains access to your Trilium [database](../../Advanced%20Usage/Database.md), they won't be able to read your encrypted notes.
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
# Read-Only Notes
|
||||
# Read-Only Notes
|
||||
Both [text](../../Note%20Types/Text.md) and [code](../../Note%20Types/Code.md) notes in Trilium can be set to read-only. When a note is in read-only mode, it is presented to the user in a non-editable view, with the option to switch to editing mode if needed.
|
||||
|
||||
## Setting Read-Only Mode with a Label
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
# Sorting Notes
|
||||
# Sorting Notes
|
||||
## Sorting Notes
|
||||
|
||||
You can sort notes by right-clicking the parent note in the note tree and selecting Advanced -> Sort notes by ... This will sort existing notes, but will not automatically sort future notes added to this parent note
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
# Themes
|
||||
# Themes
|
||||
## Default Themes
|
||||
|
||||
Trilium comes with a couple pre-installed color themes, with the default being a light theme. To switch to a dark theme or any other available theme, navigate to the Options menu (accessible via the app icon in the top-left corner), select the Appearance tab, and choose your preferred theme.
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
# Theme Gallery
|
||||
# Theme Gallery
|
||||
These are user-created themes which were made publicly available:
|
||||
|
||||
## Legacy Themes
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
# Global menu
|
||||
# Global menu
|
||||
The global menu configures the current window (zoom, keeping the window on top) and offers access to some more advanced options.
|
||||
|
||||
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
# Launch Bar
|
||||
# Launch Bar
|
||||
## Position of the Launch bar
|
||||
|
||||
Depending on the layout selected, the launcher bar will either be on the left side of the screen with buttons displayed vertically or at the top of the screen. See [Vertical and horizontal layout](Vertical%20and%20horizontal%20layout.md) for more information.
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
# Note Tree
|
||||
# Note Tree
|
||||
This page explains how to manipulate the note tree in TriliumNext, focusing on moving notes.
|
||||
|
||||
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
# Note buttons
|
||||
# Note buttons
|
||||
To the right of the [Ribbon](Ribbon.md) there are a few more buttons: 
|
||||
|
||||
* The Note Revisions button displays the [Note Revisions](../Notes/Note%20Revisions.md) for that particular note.
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
# Ribbon
|
||||
# Ribbon
|
||||
|
||||
|
||||
The ribbon allows changing options, attributes and viewing information about the current note.
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
# Vertical and horizontal layout
|
||||
# Vertical and horizontal layout
|
||||
## Layouts
|
||||
|
||||
Trilium supports two different layouts, based on your preference.
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
# Zen mode
|
||||
# Zen mode
|
||||
|
||||
|
||||
Screenshot of Zen Mode activated on a Windows 11 system with native title bar off and background effects on.
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
# Note Map
|
||||
# Note Map
|
||||
A Note map is a note type which displays a standalone version of the feature of the same name: [Note Map (Link map, Tree map)](../Advanced%20Usage/Note%20Map%20\(Link%20map%2C%20Tree%20map\).md).
|
||||
|
||||
Once created, the note map will display the relations between notes. Only the notes that are part of the parent of the note map will be displayed (including their children).
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
# Relation Map
|
||||
# Relation Map
|
||||
Relation map is a type of [Note](../Basic%20Concepts%20and%20Features/Notes.md) which visualizes notes and their [relations](../Advanced%20Usage/Attributes.md). See an example:
|
||||
|
||||
## Development process demo
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
# Developer-specific formatting
|
||||
# Developer-specific formatting
|
||||
### Inline code
|
||||
|
||||
Inline code formats text using a monospace font to indicate technical content in a sentence such as code, paths, etc.
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
# Code blocks
|
||||
# Code blocks
|
||||
|
||||
|
||||
The code blocks feature allows entering pieces of code in text notes.
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user