Nightly releases are versions built every day, containing the latest improvements
+ and bugfixes, directly from the main development branch. These versions
+ are generally useful in preparation for a release, to ensure that there
+ are no significant bugs that need to be addressed first, or they can be
+ used to confirm whether a particular bug is fixed or feature is well implemented.
+
Regarding the stability
+
Despite being on a development branch, generally the main branch is pretty
+ stable since PRs are tested before they are merged. If you notice any issues,
+ feel free to report them either via a ticket or via the Matrix.
For newer versions, Node.js imports are not officially supported anymore,
+ since we've added a bundler which makes it more difficult to reuse dependencies.
+
Theoretically it's still possible to use imports by manually setting up
+ a node_modules in the server directory via npm or pnpm.
\ No newline at end of file
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Scripting/Custom Widgets.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Scripting/Frontend Basics/Custom Widgets.html
similarity index 100%
rename from apps/server/src/assets/doc_notes/en/User Guide/User Guide/Scripting/Custom Widgets.html
rename to apps/server/src/assets/doc_notes/en/User Guide/User Guide/Scripting/Frontend Basics/Custom Widgets.html
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Scripting/Frontend Basics/Custom Widgets/CSS.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Scripting/Frontend Basics/Custom Widgets/CSS.html
new file mode 100644
index 000000000..249da3ad3
--- /dev/null
+++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Scripting/Frontend Basics/Custom Widgets/CSS.html
@@ -0,0 +1,9 @@
+
To verify that the widget is working, open the developer tools (Cmd + Shift + I)
and run document.querySelector("#my-widget"). If the element
@@ -87,5 +87,18 @@ module.exports = new MyWidget();
}
module.exports = new MyWidget();
-
Reload the application one last time. When you click the button, a "Hello
- World!" message should appear, confirming that your widget is fully functional.
\ No newline at end of file
+
parentWidget() can be given the following values:
+
+
left-pane - This renders the widget on the left side of the
+ screen where the note tree lives.
+
center-pane - This renders the widget in the center of the
+ layout in the same location that notes and splits appear.
+
note-detail-pane - This renders the widget with the
+ note in the center pane. This means it can appear multiple times with splits.
+
right-pane - This renders the widget to the right of any opened
+ notes.
+
+
Reload the application
+ one last time. When you click the button, a "Hello World!" message should
+ appear, confirming that your widget is fully functional.
Protected by typings, should catch any potential changes in API.
Yes
async-mutex
Sync
axios
Can't be directly tested, as it's exposed only via the backend script API.
sax
EverNote imports
ws
debounce
Check any action is reported from server to client (e.g. delete a note).
ejs
Onboarding / first setup
dayjs
Day notes
semver
Application should start.
https-proxy-agent
???
sax
EverNote import
ini
Affects config, generally if the application starts then it should be OK.
jsplumb
RELATION_MAP
Relation map note type
jquery.mark.es6
MARKJS
In search, when highlighting the text that matched.
In search in HTML, which might not actually be used since it seems to have been replaced by CKEditor's own find & replace dialog.
knockout.js
Used in rendering the login and main layout of the application.
normalize.min.css
Used in shared notes.
wheel-zoom.min.js
WHEEL_ZOOM
When opening a image that is in attachment.
When opening a stand-alone image note.
When zooming in a mermaid chart.
fancytree
The note tree should be fully functional.
bootstrap
Check mostly the on-boarding pages, when there is no database.
electron-debug
Run electron using npm run start-electron and check that the debug hotkeys are still working (Ctrl+Shift+I on Windows/Linux, Cmd+Alt+I for dev tools, Cmd/Ctrl+R for reload).
electron-dl
eslint
marked
Importing a markdown note.
Yes
force-graph
Note map
\ No newline at end of file
+# Per-dependency checks
+
Protected by typings, should catch any potential changes in API.
Yes
async-mutex
Sync
axios
Can't be directly tested, as it's exposed only via the backend script API.
sax
EverNote imports
ws
debounce
Check any action is reported from server to client (e.g. delete a note).
ejs
Onboarding / first setup
dayjs
Day notes
semver
Application should start.
https-proxy-agent
???
sax
EverNote import
ini
Affects config, generally if the application starts then it should be OK.
jsplumb
RELATION_MAP
Relation map note type
jquery.mark.es6
MARKJS
In search, when highlighting the text that matched.
In search in HTML, which might not actually be used since it seems to have been replaced by CKEditor's own find & replace dialog.
knockout.js
Used in rendering the login and main layout of the application.
normalize.min.css
Used in shared notes.
wheel-zoom.min.js
WHEEL_ZOOM
When opening a image that is in attachment.
When opening a stand-alone image note.
When zooming in a mermaid chart.
fancytree
The note tree should be fully functional.
bootstrap
Check mostly the on-boarding pages, when there is no database.
electron-debug
Run electron using npm run start-electron and check that the debug hotkeys are still working (Ctrl+Shift+I on Windows/Linux, Cmd+Alt+I for dev tools, Cmd/Ctrl+R for reload).
electron-dl
eslint
marked
Importing a markdown note.
Yes
force-graph
Note map
\ No newline at end of file
diff --git a/docs/Developer Guide/Developer Guide/Dependencies/Per-dependency checks/bettersqlite binaries.md b/docs/Developer Guide/Developer Guide/Dependencies/Per-dependency checks/bettersqlite binaries.md
new file mode 100644
index 000000000..5a473b5e5
--- /dev/null
+++ b/docs/Developer Guide/Developer Guide/Dependencies/Per-dependency checks/bettersqlite binaries.md
@@ -0,0 +1,25 @@
+# bettersqlite binaries
+### The native node bindings
+
+`better-sqlite3` has native Node bindings. With updates of `better-sqlite3`, but also of Electron and Node.js versions, these bindings need to be updated.
+
+Note that Electron and Node.js versions need different versions of these bindings, since Electron usually packs a different version of Node.js.
+
+During development, `pnpm install` tries to build or reuse prebuilt natives for the current Node.js version. This makes `npm run start-server` work out of the box. Trying to run `npm run start-electron` with these versions generally causes an error such as this:
+
+```
+Uncaught Exception:
+Error: The module '/Users/elian/Projects/Notes/node_modules/better-sqlite3/build/Release/better_sqlite3.node'
+was compiled against a different Node.js version using
+NODE_MODULE_VERSION 108. This version of Node.js requires
+NODE_MODULE_VERSION 116. Please try re-compiling or re-installing
+the module (for instance, using `npm rebuild` or `npm install`).
+```
+
+### How the natives are handled
+
+To avoid issues between the `server` and the `desktop`, the `desktop` build gets its own copy of the `bettersqlite3` dependency in its `node_module`. This copy is then rebuilt automatically to match the Electron version.
+
+This process of rebuilding is handled by `scripts/electron-rebuild.mts` which runs automatically after `pnpm install` (via `postinstall`).
+
+If needed, the script can be run manually again via `pnpm postinstall`.
\ No newline at end of file
diff --git a/docs/Developer Guide/Developer Guide/Old documentation/Documentation.md b/docs/Developer Guide/Developer Guide/Documentation.md
similarity index 66%
rename from docs/Developer Guide/Developer Guide/Old documentation/Documentation.md
rename to docs/Developer Guide/Developer Guide/Documentation.md
index 987582cac..4874aaa1d 100644
--- a/docs/Developer Guide/Developer Guide/Old documentation/Documentation.md
+++ b/docs/Developer Guide/Developer Guide/Documentation.md
@@ -1,29 +1,32 @@
# Documentation
-
-
-There are multiple types of documentation for Trilium:
+There are multiple types of documentation for Trilium:
* The _User Guide_ represents the user-facing documentation. This documentation can be browsed by users directly from within Trilium, by pressing F1.
* The _Developer's Guide_ represents a set of Markdown documents that present the internals of Trilium, for developers.
* _Release Notes_, this contains the change log for each released or soon-to-be-released version. The release notes are used automatically by the CI when releasing a version.
* The _Script API_, which is an automatically generated documentation for the front-end and back-end APIs for scripts.
-## Editing documentation
+## Location of the documentation
+
+All documentation is stored in the [Trilium](https://github.com/TriliumNext/Trilium) repository:
+
+* `docs/Developer Guide` contains Markdown documentation that can be modified either externally (using a Markdown editor, or internally using Trilium).
+* `docs/Release Notes` is also stored in Markdown format and can be freely edited.
+* `docs/Script API` contains auto-generated files and thus must not be modified.
+* `docs/User Guide` contains also Markdown-only documentation but must generally not be edited externally.
+ * The reason is that the `pnpm edit-docs:edit-docs` feature will not only import/export this documentation, but also generate the corresponding HTML documentation and meta structure in `src/public/app/doc_notes/en/User Guide`.
+ * It's theoretically possible to edit the Markdown files externally and then run `docs:edit` and trigger a change in order to build the documentation, but that would not be a very productive workflow.
+
+## Editing the documentation
There are two ways to modify documentation:
* Using a special mode of Trilium.
* By manually editing the files.
-### Using `docs:edit`
+### Using the `edit-docs` app
-To edit the documentation using Trilium, set up a working development environment and run the following commands:
-
-* On most operating systems, `npm run electron:switch` followed by `npm run docs:edit`
-* On NixOS, `npm run docs:edit-nix`.
-
-> [!NOTE]
-> `npm run docs:edit` acts very similar to `npm run electron:start` in the sense that you cannot both be editing documentation and starting a server. Using both `npm run electron:start` and `docs:edit` is possible, since they are using the same Electron instance.
+To edit the documentation using Trilium, set up a working development environment via Environment Setup and run the following command: `pnpm edit-docs:edit-docs`.
How it works:
@@ -50,24 +53,30 @@ Important aspects to consider:
* The Trilium import/export mechanism is not perfect, so if you make some modifications to the documentation using `docs:edit`, at the next import/export/import cycle some whitespace might get thrown in. It's generally safe to commit the changes as-is.
* Since we are importing Markdown, editing HTML and then exporting the HTML back to Markdown there might be some edge cases where the formatting is not properly preserved. Try to identify such cases and report them in order to get them fixed (this will benefit also the users).
-## Location of the documentation
+## Automation
-All documentation is stored in the [Notes](https://github.com/TriliumNext/Trilium) repository:
+The documentation is built via `apps/build-docs`:
-* `docs/Developer Guide` contains Markdown documentation that can be modified either externally (using a Markdown editor, or internally using Trilium).
-* `docs/Release Notes` is also stored in Markdown format and can be freely edited.
-* `docs/Script API` contains auto-generated files and thus must not be modified.
-* `docs/User Guide` contains also Markdown-only documentation but must generally not be edited externally.
- * The reason is that the `docs:edit` feature will not only import/export this documentation, but also generate the corresponding HTML documentation and meta structure in `src/public/app/doc_notes/en/User Guide`.
- * It's theoretically possible to edit the Markdown files externally and then run `docs:edit` and trigger a change in order to build the documentation, but that would not be a very productive workflow.
+1. The output directory is cleared.
+2. The User Guide and the Developer Guide are built.
+ 1. The documentation from the repo is archived and imported into an in-memory instance.
+ 2. The documentation is exported using the shared theme.
+3. The API docs (internal and ETAPI) are statically rendered via Redocly.
+4. The script API is generated via `typedoc`
+
+The `deploy-docs` workflow triggers the documentation build and uploads it to CloudFlare Pages.
## Updating the Script API
As mentioned previously, the Script API is not manually editable since it is auto-generated using TypeDoc.
-To update the API documentation, simply run `npm run docs:build`. Compare the changes (if any) and commit them.
+To update the API documentation, simply run `pnpm docs:build`. Compare the changes (if any) and commit them.
-Note that in order to simulate the environment a script would have, some fake source files (in the sense that they are only used for documentation) are being used as entrypoints for the documentation:
+Note that in order to simulate the environment a script would have, some fake source files (in the sense that they are only used for documentation) are being used as entrypoints for the documentation. Look for `backend_script_entrypoint` and `frontend_script_entrypoint` in `apps/build-docs/src`.
-* For back-end scripts, the script is located in `src/services/backend_script_entrypoint.ts`.
-* For front-end scripts, the script is located in `src/public/app/services/frontend_script_entrypoint.ts`.
\ No newline at end of file
+## Building locally
+
+In the Git root:
+
+* Run `pnpm docs:build`. The built documentation will be available in `site` at Git root.
+* To also run a webserver to test it, run `pnpm docs:preview` (this will not build the documentation) and navigate to `localhost:9000`.
\ No newline at end of file
diff --git a/docs/Developer Guide/Developer Guide/Old documentation/Documentation/Documentation references in th.md b/docs/Developer Guide/Developer Guide/Documentation/Documentation references in th.md
similarity index 69%
rename from docs/Developer Guide/Developer Guide/Old documentation/Documentation/Documentation references in th.md
rename to docs/Developer Guide/Developer Guide/Documentation/Documentation references in th.md
index 1c9a9fea9..79c1bd80e 100644
--- a/docs/Developer Guide/Developer Guide/Old documentation/Documentation/Documentation references in th.md
+++ b/docs/Developer Guide/Developer Guide/Documentation/Documentation references in th.md
@@ -13,6 +13,8 @@ https://triliumnext.github.io/Docs/Wiki/
There is a pattern of “?” buttons throughout the application which make use of the `data-help-page` attribute. Whenever these buttons are pressed, the user is redirected to the corresponding wiki page by prepending the wiki root URL to the `data-help-page` attribute.
+### Deprecated `help-page` attribute
+
Since the current wiki has a different structure than the original, for example to link to [https://github.com/TriliumNext/Docs/blob/main/Wiki/tree-concepts.md](https://github.com/TriliumNext/Docs/blob/main/Wiki/tree-concepts.md) the `data-help-page` attribute must be set to `tree-concepts.md`.
For links to headings, simply add the heading after the `.md`: `tree-concepts.md#prefix`
@@ -20,4 +22,12 @@ For links to headings, simply add the heading after the `.md`: `tree-concepts.md
You can identify those by looking for:
* `.attr("data-help-page"`
-* `data-help-page="`
\ No newline at end of file
+* `data-help-page="`
+
+### More modern `data-in-app-help` attribute
+
+Instead of opening in a web browser, this opens the help directly in the application in a split view. This is handled via the `data-in-app-help` attribute, where the value is the note ID of the help page without the `_help_` prefix.
+
+### React
+
+Use the `HelpButton` component in the same fashion as the `data-in-app-help` attribute.
\ No newline at end of file
diff --git a/docs/Developer Guide/Developer Guide/Old documentation/Documentation_image.png b/docs/Developer Guide/Developer Guide/Old documentation/Documentation_image.png
deleted file mode 100644
index 542bb7858..000000000
Binary files a/docs/Developer Guide/Developer Guide/Old documentation/Documentation_image.png and /dev/null differ
diff --git a/docs/Developer Guide/Developer Guide/Old documentation/Installation/Download latest nightly and in.md b/docs/Developer Guide/Developer Guide/Old documentation/Installation/Download latest nightly and in.md
deleted file mode 100644
index 0d5f2a2e4..000000000
--- a/docs/Developer Guide/Developer Guide/Old documentation/Installation/Download latest nightly and in.md
+++ /dev/null
@@ -1,12 +0,0 @@
-# Download latest nightly and install it
-On Ubuntu:
-
-```
-#!/usr/bin/env bash
-
-name=TriliumNotes-linux-x64-nightly.deb
-rm -f $name*
-wget https://github.com/TriliumNext/Trilium/releases/download/nightly/$name
-sudo apt-get install ./$name
-rm $name
-```
\ No newline at end of file
diff --git a/docs/Developer Guide/Developer Guide/Old documentation/Project maintenance/Updating dependencies/bettersqlite binaries.md b/docs/Developer Guide/Developer Guide/Old documentation/Project maintenance/Updating dependencies/bettersqlite binaries.md
deleted file mode 100644
index 5538646ca..000000000
--- a/docs/Developer Guide/Developer Guide/Old documentation/Project maintenance/Updating dependencies/bettersqlite binaries.md
+++ /dev/null
@@ -1,41 +0,0 @@
-# bettersqlite binaries
-### The native node bindings
-
-`better-sqlite3` has native Node bindings. With updates of `better-sqlite3`, but also of Electron and Node.js versions, these bindings need to be updated.
-
-Note that Electron and Node.js versions need different versions of these bindings, since Electron usually packs a different version of Node.js.
-
-During development, `npm install` tries to build or reuse prebuilt natives for the current Node.js version. This makes `npm run start-server` work out of the box. Trying to run `npm run start-electron` with these versions generally causes an error such as this:
-
-```
-Uncaught Exception:
-Error: The module '/Users/elian/Projects/Notes/node_modules/better-sqlite3/build/Release/better_sqlite3.node'
-was compiled against a different Node.js version using
-NODE_MODULE_VERSION 108. This version of Node.js requires
-NODE_MODULE_VERSION 116. Please try re-compiling or re-installing
-the module (for instance, using `npm rebuild` or `npm install`).
-```
-
-### How the natives are handled
-
-Locally, this can be fixed by rebuilding the binaries, which is what `npm run switch-electron` does, which uses `electron-rebuild` under the hood.
-
-When the deliveries are built (see Build deliveries locally), it is not feasible to rebuild the dependencies since we are building for multiple platforms. Luckily, `better-sqlite3` provides these prebuilt binaries from us, available as artifacts on [their GitHub releases page](https://github.com/WiseLibs/better-sqlite3/releases/).
-
-The build script manages the natives for `better-sqlite3` by keeping a copy of the `.node` file for every platform in `bin/better-sqlite3`.
-
-Whenever the version of `better-sqlite3` changes, the `.node` files must also be renewed based on their releases page. To simplify this process, a script was created in `bin/better-sqlite3/update.sh`.
-
-## How to update the natives
-
-The update script needs to know the version of Electron or Node.js for which to download the prebuilt binaries.
-
-If you get errors during download, check on the [releases page](https://github.com/WiseLibs/better-sqlite3/releases/) to ensure that this particular combination of Electron/Node actually exists for the given release.
-
-To determine the `NODE_MODULE_VERSION` that is required, look for `This version of Node.js requires`
-`NODE_MODULE_VERSION` in the error when starting Trilium via:
-
-* `npm run start-electron` (or run any Electron [delivery](../../../Building/Build%20deliveries%20locally.md)), case in which the `ELECTRON_VERSION` variable needs to be changed.
-* `npm run start-server` (or run the Linux server delivery), case in which the `NODE_VERSION` variable needs to be changed.
-
-Check which files got changed after running the update script and for each platform that got changed, test it locally via Build deliveries locally or via the CI.
\ No newline at end of file
diff --git a/docs/Developer Guide/Developer Guide/Old documentation/Scripting/Server-side imports.md b/docs/Developer Guide/Developer Guide/Old documentation/Scripting/Server-side imports.md
deleted file mode 100644
index c19366cee..000000000
--- a/docs/Developer Guide/Developer Guide/Old documentation/Scripting/Server-side imports.md
+++ /dev/null
@@ -1,16 +0,0 @@
-# Server-side imports
-Trilium Notes allowed the use of Common.js module imports inside backend scripts, such as:
-
-```
-const isBetween = require('dayjs/plugin/isBetween')
-api.dayjs.extend(isBetween)
-```
-
-For TriliumNext, the backend has been switched to use ESM which has a slightly more complicated syntax. Instead of `require` we now have `import` but which is asynchronous so it will require an `await`:
-
-```
-const isBetween = (await import("dayjs/plugin/isBetween")).default;
-api.dayjs.extend(isBetween);
-```
-
-Note that `.default` is also usually needed to obtain the same behaviour as a CJS import. When in doubt, use `console.log` to see the output of the value returned by `await import`.
\ No newline at end of file
diff --git a/docs/Developer Guide/Developer Guide/Old documentation/Scripting/Widgets.md b/docs/Developer Guide/Developer Guide/Old documentation/Scripting/Widgets.md
deleted file mode 100644
index 57de0ad15..000000000
--- a/docs/Developer Guide/Developer Guide/Old documentation/Scripting/Widgets.md
+++ /dev/null
@@ -1,33 +0,0 @@
-# Widgets
-To create a basic widget, simply create a code note with type “JS frontend”. Add the `#widget` label in order for it to be loaded at startup.
-
-```
-const template = ``;
-
-class MyWidget extends api.BasicWidget {
- get position() { return 1; }
- get parentWidget() { return "left-pane" }
-
- doRender() {
- this.$widget = $(template);
- return this.$widget;
- }
-}
-
-module.exports = new MyWidget();
-```
-
-`parentWidget()` can be given the following values:
-
-* `left-pane` - This renders the widget on the left side of the screen where the note tree lives.
-* `center-pane` - This renders the widget in the center of the layout in the same location that notes and splits appear.
-* `note-detail-pane` - This renders the widget _with_ the note in the center pane. This means it can appear multiple times with splits.
-* `right-pane` - This renders the widget to the right of any opened notes.
-
-* * *
-
-Reference:
-
-* [https://trilium.rocks/X7pxYpiu0lgU](https://trilium.rocks/X7pxYpiu0lgU)
-* [https://github.com/zadam/trilium/wiki/Widget-Basics](https://github.com/zadam/trilium/wiki/Widget-Basics)
-* [https://github.com/zadam/trilium/wiki/Frontend-Basics](https://github.com/zadam/trilium/wiki/Frontend-Basics)
\ No newline at end of file
diff --git a/docs/Developer Guide/Developer Guide/Old documentation/Sub-projects/CKEditor/Building the editor.md b/docs/Developer Guide/Developer Guide/Old documentation/Sub-projects/CKEditor/Building the editor.md
deleted file mode 100644
index 940617026..000000000
--- a/docs/Developer Guide/Developer Guide/Old documentation/Sub-projects/CKEditor/Building the editor.md
+++ /dev/null
@@ -1,21 +0,0 @@
-# Building the editor
-First, make sure Environment setup is set up.
-
-## Trigger the build
-
-```
-cd packages/ckeditor5-build-trilium
-yarn build
-```
-
-This will trigger a change in the `build` directory.
-
-## Copy the build artifact to the main repo
-
-Go to `packages/ckeditor5-build-balloon-trilium/build` and copy `ckeditor.js` and `ckeditor.js.map` to `libraries/ckeditor` in the `Notes` repository.
-
-An example shell command to copy it:
-
-```
-cp build/ckeditor.* ~/Projects/TriliumNext/Notes/libraries/ckeditor/
-```
\ No newline at end of file
diff --git a/docs/Developer Guide/Developer Guide/Old documentation/Sub-projects/CKEditor/Environment setup.md b/docs/Developer Guide/Developer Guide/Old documentation/Sub-projects/CKEditor/Environment setup.md
deleted file mode 100644
index 76819a12b..000000000
--- a/docs/Developer Guide/Developer Guide/Old documentation/Sub-projects/CKEditor/Environment setup.md
+++ /dev/null
@@ -1,26 +0,0 @@
-# Environment setup
-## Clone the repository
-
-To set up the repository:
-
-```
-git clone https://github.com/TriliumNext/trilium-ckeditor5.git
-```
-
-## Install dependencies
-
-First, install root dependencies:
-
-```
-cd trilium-ckeditor5
-yarn install
-```
-
-Secondly, install the Trilium build dependencies:
-
-```
-cd packages/ckeditor5-build-trilium
-yarn install
-```
-
-To trigger the build, see Building the editor.
\ No newline at end of file
diff --git a/docs/Developer Guide/Developer Guide/Old documentation/Sub-projects/CKEditor/Updating to a newer version of.md b/docs/Developer Guide/Developer Guide/Old documentation/Sub-projects/CKEditor/Updating to a newer version of.md
deleted file mode 100644
index 6e7808f67..000000000
--- a/docs/Developer Guide/Developer Guide/Old documentation/Sub-projects/CKEditor/Updating to a newer version of.md
+++ /dev/null
@@ -1,65 +0,0 @@
-# Updating to a newer version of CKEditor
-## Before updating
-
-Make sure that all the plugins are compatible with this version: Versions and external plugins. If not, they will need to be updated to the same version as the one you are updating, by altering their `package.json`.
-
-If the plugin is external to the Trilium organisation, it needs to be forked first.
-
-## Environment setup
-
-The first step is to add the CKEditor source as a remote. This only needs to be done once.
-
-```
-git remote add upstream ssh://git@github.com/ckeditor/ckeditor5.git
-git fetch upstream
-```
-
-## Update steps
-
-Due to how the repository is structured, updates to the CKEditor are a bit difficult.
-
-1. `git fetch upstream`
-2. Pick a version and merge with it: `git merge -X theirs v99.2.0`
-3. When there are complicated conflicts, sometimes it's easier to take everything from the target version instead, for a given path: `git checkout v99.2.0 -- "packages/ckeditor5-list/**"`.
-4. Go in `packages/ckeditor5-build-trilium/package.json` and run `node sync-version.js` to update the `package.json` with the new versions. Review and commit the change.
-5. Follow again the dependency setup in Environment setup, as they have changed.
-6. [Run the build](Building%20the%20editor.md) and check that it works.
-
-## Final steps
-
-1. Start the TriliumNext server
-2. If updated to a newer version of CKEditor, check type `CKEDITOR_VERSION` in the browser/Electron console to ensure that the correct version is used.
-3. Do a basic sanity check as well.
-4. Commit and push the change on both sides (in the `trilium-ckeditor5` repo and in the `Notes` repo).
-
-## Troubleshooting client side errors
-
-These errors might show up when testing the Trilium app:
-
-```
-ReferenceError: CKEditor is not defined
-```
-
-Usually this is a side effect of another error, check the logs carefully to see if there is any other related error (perhaps a `CKEditorError`).
-
-* * *
-
-```
-Uncaught error: Message: CKEditorError: ckeditor-duplicated-modules
-```
-
-Most likely cause is one of the external plugins is incompatible with this version.
-
-For example, to disable the Math plugin, go to `packages/ckeditor5-build-trilium/src/config.ts` and modify:
-
-```diff
--import Math from '@triliumnext/ckeditor5-math/src/math';
--import AutoformatMath from '@triliumnext/ckeditor5-math/src/autoformatmath';
-
-export const COMMON_PLUGINS = [
-- Math,
-- AutoformatMath,
-]
-```
-
-In this case, make sure to align the version of all the external plugins with the one you are updating to, usually by forking the external plugin and updating its versions.
\ No newline at end of file
diff --git a/docs/Developer Guide/Developer Guide/Old documentation/Sub-projects/CKEditor/Versions and external plugins.md b/docs/Developer Guide/Developer Guide/Old documentation/Sub-projects/CKEditor/Versions and external plugins.md
deleted file mode 100644
index 2fe124c31..000000000
--- a/docs/Developer Guide/Developer Guide/Old documentation/Sub-projects/CKEditor/Versions and external plugins.md
+++ /dev/null
@@ -1,8 +0,0 @@
-# Versions and external plugins
-## External plugins
-
-| | | |
-| --- | --- | --- |
-| trilium-ckeditor5 | 43.2.0 | |
-| `ckeditor5-math` | | See ckeditor5-math. |
-| | | |
\ No newline at end of file
diff --git a/docs/Developer Guide/Developer Guide/Old documentation/Sub-projects/ckeditor5-math.md b/docs/Developer Guide/Developer Guide/Old documentation/Sub-projects/ckeditor5-math.md
deleted file mode 100644
index 91b6b265f..000000000
--- a/docs/Developer Guide/Developer Guide/Old documentation/Sub-projects/ckeditor5-math.md
+++ /dev/null
@@ -1,29 +0,0 @@
-# ckeditor5-math
-ckeditor5-math in action.
-
-A fork of [isaul32/ckeditor5-math](https://github.com/isaul32/ckeditor5-math), which is the CKEditor5 plugin which adds the math functionality. The fork was created to handle #297: Insert Math appears to be broken.
-
-## Development environment
-
-* Tested on Node.js 20.
-* The package manager is yarn 1 (v1.22.22 is known to be working fine for it at the time of writing).
-
-Important commands:
-
-* To check if the code has any formatting issues: `yarn lint`
-* To start a live preview: `yarn start`
-* To run the tests: `yarn test`
- * Note that this requires Chromium, on NixOS this can be achieved by running a `nix-shell -p chromium`, and running `CHROME_BIN=$(which chromium) yarn test` inside it.
-
-## 📦 Packages
-
-The built artifact of the plugin is released by the CI and available on the [GitHub NPM registry](https://github.com/TriliumNext/ckeditor5-math/pkgs/npm/ckeditor5-math).
-
-Note that due to limitations on GitHub's registry, it is not possible to install this package without setting up a personal access token (even though the package itself is public). See [missing note] for more information.
-
-## ⬆️ Integrating with CKEditor
-
-1. Release a new version: Release management & continuous integration
-2. In `trilium-ckeditor5`, go to `packages/ckeditor5-build-trilium/package.json` in the CKEditor repository and change the dependency of `@triliumnext/ckeditor5-math` to the newly released version.
-3. Run `yarn install`.
-4. Proceed with Building the editor to integrate everything into TriliumNext and then commit the change.
\ No newline at end of file
diff --git a/docs/Developer Guide/Developer Guide/Old documentation/Sub-projects/ckeditor5-math/Release management & continuou.md b/docs/Developer Guide/Developer Guide/Old documentation/Sub-projects/ckeditor5-math/Release management & continuou.md
deleted file mode 100644
index 1511f4bfc..000000000
--- a/docs/Developer Guide/Developer Guide/Old documentation/Sub-projects/ckeditor5-math/Release management & continuou.md
+++ /dev/null
@@ -1,16 +0,0 @@
-# Release management & continuous integration
-To automate the release process, a GitHub workflow has been added which builds the package and releases it over to GitHub NPM registry.
-
-The workflow publishes a release whenever a tag with the correct format is pushed.
-
-The steps are as follows:
-
-1. Ensure that the source code is clean and ready for a release.
-2. Go to `package.json` and bump the `version` field.
-3. Commit the changes.
-4. Tag the commit with `v1.2.3`, with the correct version number.
-5. Push the changes.
-
-Then follow the CI and it should indicate success. Afterwards, check the [package](https://github.com/TriliumNext/ckeditor5-math/pkgs/npm/ckeditor5-math)section to ensure that the package is in the “Recent Versions” section.
-
-If the changes could benefit upstream, consider opening a pull request with the changes there as well.
\ No newline at end of file
diff --git a/docs/Developer Guide/Developer Guide/Old documentation/Sub-projects/ckeditor5-math/Updating with upstream.md b/docs/Developer Guide/Developer Guide/Old documentation/Sub-projects/ckeditor5-math/Updating with upstream.md
deleted file mode 100644
index b69003358..000000000
--- a/docs/Developer Guide/Developer Guide/Old documentation/Sub-projects/ckeditor5-math/Updating with upstream.md
+++ /dev/null
@@ -1,21 +0,0 @@
-# Updating with upstream
-If there was a change in the upstream repository ([isaul32/ckeditor5-math](https://github.com/isaul32/ckeditor5-math)), it can be integrated as follows:
-
-1. Add the upstream as remote (`git remote add upstream ssh://git@github.com/isaul32/ckeditor5-math.git`).
-2. Fetch the changes: `git fetch upstream`
-3. Merge with a tag: `git merge v43.1.2`
-4. Solve the conflict in `package.json` by:
- 1. Taking the same version as the upcoming one and appending `-hotfix1`.
- 2. Keeping the `@triliumnext/ckeditor5-math` name.
-5. Install dependencies: `yarn install`
-6. Check that the build works via `yarn prepublishOnly`.
-7. Commit the changes, push them.
-8. Release a version with Release management & continuous integration.
-
-## CI job not triggered after pushing all the upstream tags
-
-If the CI job was not triggered, you might have accidentally pushed a lot of tags using `git push --tags`. Manually delete the tag and push it again:
-
-```diff
-git push -d origin v43.1.2-hotfix1 && git push --tags
-```
\ No newline at end of file
diff --git a/docs/Developer Guide/Developer Guide/Old documentation/Testing/Integration testing/1_Setting up authentication_.png b/docs/Developer Guide/Developer Guide/Old documentation/Testing/Integration testing/1_Setting up authentication_.png
deleted file mode 100644
index 020472c6d..000000000
Binary files a/docs/Developer Guide/Developer Guide/Old documentation/Testing/Integration testing/1_Setting up authentication_.png and /dev/null differ
diff --git a/docs/Developer Guide/Developer Guide/Old documentation/Testing/Integration testing/Running tests.md b/docs/Developer Guide/Developer Guide/Old documentation/Testing/Integration testing/Running tests.md
deleted file mode 100644
index 3ab98a39c..000000000
--- a/docs/Developer Guide/Developer Guide/Old documentation/Testing/Integration testing/Running tests.md
+++ /dev/null
@@ -1,38 +0,0 @@
-# Running tests
-## First-time run
-
-Before starting Playwright, it has to be installed locally via:
-
-```
-npx playwright install
-```
-
-## Starting the integration test server
-
-There are two types of integration test servers:
-
-* `npm run integration-mem-db` will run a server with dev mode disabled.
- * This is usually what the end user will see when accessing a server instance.
- * It will not test the Electron/desktop side of the application.
- * Changes to the public scripts will not take effect until running `npm run webpack`.
-* `npm run integration-mem-db-dev` will run a server with dev mode enabled.
- * This is usually what a dev sees when running `npm run start-server`.
- * The difference with the production one is that the assets are loaded directly from files and as such it does not require `npm run webpack` to see changes.
-
-Either options will open up a server on [localhost:8082](http://localhost:8082) that can be accessed either manually via the browser or via Playwright.
-
-When asked for a password, the password is `demo1234`.
-
-## Starting the interactive test runner
-
-After starting the integration test server, to run the Playwright UI, run in the terminal:
-
-```
-npx playwright test --ui
-```
-
-It is also possible to run the interactive code generator instead:
-
-```
-npx playwright codegen
-```
\ No newline at end of file
diff --git a/docs/Developer Guide/Developer Guide/Old documentation/Testing/Integration testing/Setting up authentication.md b/docs/Developer Guide/Developer Guide/Old documentation/Testing/Integration testing/Setting up authentication.md
deleted file mode 100644
index 4df7880fe..000000000
--- a/docs/Developer Guide/Developer Guide/Old documentation/Testing/Integration testing/Setting up authentication.md
+++ /dev/null
@@ -1,12 +0,0 @@
-# Setting up authentication
-There is a setup test that stores the authentication token so that it can be reused throughout all the tests.
-
-If tests fail due to being stuck on login, then it must be run.
-
-To run it manually press “all” near the “Status:” text on top-left of the window
-
-
-
-Then check “setup” and look for `auth.setup.ts` and press its corresponding Run button:
-
-
\ No newline at end of file
diff --git a/docs/Developer Guide/Developer Guide/Old documentation/Testing/Integration testing/Setting up authentication_.png b/docs/Developer Guide/Developer Guide/Old documentation/Testing/Integration testing/Setting up authentication_.png
deleted file mode 100644
index 4b260dfbc..000000000
Binary files a/docs/Developer Guide/Developer Guide/Old documentation/Testing/Integration testing/Setting up authentication_.png and /dev/null differ
diff --git a/docs/Developer Guide/Developer Guide/Old documentation/Testing.md b/docs/Developer Guide/Developer Guide/Testing.md
similarity index 77%
rename from docs/Developer Guide/Developer Guide/Old documentation/Testing.md
rename to docs/Developer Guide/Developer Guide/Testing.md
index 95efd9919..a1f8a1983 100644
--- a/docs/Developer Guide/Developer Guide/Old documentation/Testing.md
+++ b/docs/Developer Guide/Developer Guide/Testing.md
@@ -17,17 +17,14 @@ Note that some integration tests rely on an in-memory database in order to funct
### REST API testing for the server
-Some original work was done by Zadam in `/test-etapi`, using `.http` files.
-
-New effort using `vitest` and `supertest` to initialize the Express server and run assertions without having to make actual requests to the server.
+API tests are handled via `vitest` and `supertest` to initialize the Express server and run assertions without having to make actual requests to the server.
An important aspect is that we have access to the Express `app` which allows for interesting assertions such as checking the state of the server, registering debug middleware and so on.
-One example is `src/share/routes.spec.ts`.
+One example is `src/share/routes.spec.ts`, or for the ETAPI in `apps/server/spec/etapi`.
These integration tests are run alongside unit tests.
## End-to-end testing
-* This tests both the client and the server, by running the server and then using Playwright to query the state of the page.
-* These can be found in `/e2e`.
\ No newline at end of file
+See e2e tests.
\ No newline at end of file
diff --git a/docs/Developer Guide/Developer Guide/Testing/End-to-end tests.md b/docs/Developer Guide/Developer Guide/Testing/End-to-end tests.md
new file mode 100644
index 000000000..387940158
--- /dev/null
+++ b/docs/Developer Guide/Developer Guide/Testing/End-to-end tests.md
@@ -0,0 +1,31 @@
+# End-to-end tests
+* This tests both the client and the server, by running the server and then using Playwright to query the state of the page.
+* These can be found in `apps/server-e2e` and `apps/desktop/e2e`.
+
+## First-time run
+
+Before starting Playwright, it has to be installed locally via:
+
+```
+pnpm playwright install
+```
+
+## Starting the integration test server
+
+Simply run `pnpm e2e` in one of the e2e projects.
+
+The integration server doesn't have authentication enabled to avoid login issues.
+
+## Starting the interactive test runner
+
+After starting the integration test server, to run the Playwright UI, run in the terminal:
+
+```
+pnpm playwright test --ui
+```
+
+It is also possible to run the interactive code generator instead:
+
+```
+pnpm playwright codegen
+```
\ No newline at end of file
diff --git a/docs/Developer Guide/Developer Guide/Testing/Integration testing.md b/docs/Developer Guide/Developer Guide/Testing/Integration testing.md
new file mode 100644
index 000000000..e69de29bb
diff --git a/docs/Developer Guide/Developer Guide/Old documentation/Testing/Integration testing/Test database.md b/docs/Developer Guide/Developer Guide/Testing/Test database.md
similarity index 100%
rename from docs/Developer Guide/Developer Guide/Old documentation/Testing/Integration testing/Test database.md
rename to docs/Developer Guide/Developer Guide/Testing/Test database.md
diff --git a/docs/Developer Guide/Developer Guide/Old documentation/Troubleshooting/Error [TransformError] The pac.md b/docs/Developer Guide/Developer Guide/Troubleshooting/Error [TransformError] The pac.md
similarity index 99%
rename from docs/Developer Guide/Developer Guide/Old documentation/Troubleshooting/Error [TransformError] The pac.md
rename to docs/Developer Guide/Developer Guide/Troubleshooting/Error [TransformError] The pac.md
index 8a93a52be..82a5d93a8 100644
--- a/docs/Developer Guide/Developer Guide/Old documentation/Troubleshooting/Error [TransformError] The pac.md
+++ b/docs/Developer Guide/Developer Guide/Troubleshooting/Error [TransformError] The pac.md
@@ -36,5 +36,5 @@ The solution is to remove `node_modules` and reinstall all dependencies:
```
rm -r node_modules
-npm install
+pnpm install
```
\ No newline at end of file
diff --git a/docs/User Guide/!!!meta.json b/docs/User Guide/!!!meta.json
index 24e168341..a38998354 100644
--- a/docs/User Guide/!!!meta.json
+++ b/docs/User Guide/!!!meta.json
@@ -14081,6 +14081,33 @@
"format": "markdown",
"dataFileName": "Safe mode.md",
"attachments": []
+ },
+ {
+ "isClone": false,
+ "noteId": "HAIOFBoYIIdO",
+ "notePath": [
+ "pOsGYCXsbNQG",
+ "tC7s2alapj8V",
+ "HAIOFBoYIIdO"
+ ],
+ "title": "Nightly release",
+ "notePosition": 260,
+ "prefix": null,
+ "isExpanded": false,
+ "type": "text",
+ "mime": "text/html",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-moon",
+ "isInheritable": false,
+ "position": 30
+ }
+ ],
+ "format": "markdown",
+ "dataFileName": "Nightly release.md",
+ "attachments": []
}
]
},
@@ -14617,152 +14644,238 @@
{
"type": "label",
"name": "iconClass",
- "value": "bx bx-info-circle",
+ "value": "bx bx-window",
"isInheritable": false,
"position": 40
}
],
"format": "markdown",
"dataFileName": "Frontend Basics.md",
- "attachments": []
- },
- {
- "isClone": false,
- "noteId": "es8OU2GuguFU",
- "notePath": [
- "pOsGYCXsbNQG",
- "CdNpE2pqjmI6",
- "es8OU2GuguFU"
- ],
- "title": "Examples",
- "notePosition": 50,
- "prefix": null,
- "isExpanded": false,
- "type": "text",
- "mime": "text/html",
- "attributes": [
- {
- "type": "label",
- "name": "shareAlias",
- "value": "examples",
- "isInheritable": false,
- "position": 20
- },
- {
- "type": "label",
- "name": "iconClass",
- "value": "bx bx-code-alt",
- "isInheritable": false,
- "position": 30
- }
- ],
- "format": "markdown",
"attachments": [],
- "dirFileName": "Examples",
+ "dirFileName": "Frontend Basics",
"children": [
{
"isClone": false,
- "noteId": "TjLYAo3JMO8X",
+ "noteId": "MgibgPcfeuGz",
"notePath": [
"pOsGYCXsbNQG",
"CdNpE2pqjmI6",
- "es8OU2GuguFU",
- "TjLYAo3JMO8X"
+ "yIhgI5H7A2Sm",
+ "MgibgPcfeuGz"
],
- "title": "\"New Task\" launcher button",
+ "title": "Custom Widgets",
"notePosition": 10,
"prefix": null,
"isExpanded": false,
"type": "text",
- "mime": "text/html",
+ "mime": "text/markdown",
"attributes": [
{
- "type": "relation",
- "name": "internalLink",
- "value": "xYjQUYhpbUEW",
- "isInheritable": false,
- "position": 10
- },
- {
- "type": "relation",
- "name": "internalLink",
- "value": "xYmIYSP6wE3F",
+ "type": "label",
+ "name": "shareAlias",
+ "value": "custom-widget",
"isInheritable": false,
"position": 20
},
- {
- "type": "relation",
- "name": "internalLink",
- "value": "6f9hih2hXXZk",
- "isInheritable": false,
- "position": 30
- },
- {
- "type": "relation",
- "name": "internalLink",
- "value": "zEY4DaJG4YT5",
- "isInheritable": false,
- "position": 40
- },
- {
- "type": "relation",
- "name": "internalLink",
- "value": "m1lbrzyKDaRB",
- "isInheritable": false,
- "position": 50
- },
- {
- "type": "relation",
- "name": "internalLink",
- "value": "s8alTXmpFR61",
- "isInheritable": false,
- "position": 60
- },
- {
- "type": "relation",
- "name": "internalLink",
- "value": "yIhgI5H7A2Sm",
- "isInheritable": false,
- "position": 70
- },
{
"type": "label",
"name": "iconClass",
- "value": "bx bx-task",
+ "value": "bx bxs-widget",
"isInheritable": false,
- "position": 80
- },
- {
- "type": "label",
- "name": "shareAlias",
- "value": "new-task-button",
- "isInheritable": false,
- "position": 90
+ "position": 30
}
],
"format": "markdown",
- "dataFileName": "New Task launcher button.md",
- "attachments": [
+ "dataFileName": "Custom Widgets.md",
+ "attachments": [],
+ "dirFileName": "Custom Widgets",
+ "children": [
{
- "attachmentId": "9C2JA6tdtRpN",
- "title": "image.png",
- "role": "image",
- "mime": "image/png",
- "position": 10,
- "dataFileName": "New Task launcher button_i.png"
+ "isClone": false,
+ "noteId": "YNxAqkI5Kg1M",
+ "notePath": [
+ "pOsGYCXsbNQG",
+ "CdNpE2pqjmI6",
+ "yIhgI5H7A2Sm",
+ "MgibgPcfeuGz",
+ "YNxAqkI5Kg1M"
+ ],
+ "title": "Word count widget",
+ "notePosition": 10,
+ "prefix": null,
+ "isExpanded": false,
+ "type": "text",
+ "mime": "text/html",
+ "attributes": [
+ {
+ "type": "relation",
+ "name": "internalLink",
+ "value": "6tZeKvSHEUiB",
+ "isInheritable": false,
+ "position": 10
+ },
+ {
+ "type": "relation",
+ "name": "internalLink",
+ "value": "6f9hih2hXXZk",
+ "isInheritable": false,
+ "position": 20
+ },
+ {
+ "type": "relation",
+ "name": "internalLink",
+ "value": "s8alTXmpFR61",
+ "isInheritable": false,
+ "position": 30
+ },
+ {
+ "type": "label",
+ "name": "shareAlias",
+ "value": "word-count",
+ "isInheritable": false,
+ "position": 40
+ }
+ ],
+ "format": "markdown",
+ "dataFileName": "Word count widget.md",
+ "attachments": [
+ {
+ "attachmentId": "JhM9NWfebzPi",
+ "title": "image.png",
+ "role": "image",
+ "mime": "image/png",
+ "position": 10,
+ "dataFileName": "Word count widget_image.png"
+ }
+ ]
+ },
+ {
+ "isClone": false,
+ "noteId": "SynTBQiBsdYJ",
+ "notePath": [
+ "pOsGYCXsbNQG",
+ "CdNpE2pqjmI6",
+ "yIhgI5H7A2Sm",
+ "MgibgPcfeuGz",
+ "SynTBQiBsdYJ"
+ ],
+ "title": "Widget Basics",
+ "notePosition": 20,
+ "prefix": null,
+ "isExpanded": false,
+ "type": "text",
+ "mime": "text/markdown",
+ "attributes": [
+ {
+ "type": "relation",
+ "name": "internalLink",
+ "value": "zEY4DaJG4YT5",
+ "isInheritable": false,
+ "position": 10
+ },
+ {
+ "type": "relation",
+ "name": "internalLink",
+ "value": "BFs8mudNFgCS",
+ "isInheritable": false,
+ "position": 20
+ },
+ {
+ "type": "relation",
+ "name": "internalLink",
+ "value": "GLks18SNjxmC",
+ "isInheritable": false,
+ "position": 30
+ },
+ {
+ "type": "label",
+ "name": "shareAlias",
+ "value": "widget-basics",
+ "isInheritable": false,
+ "position": 20
+ },
+ {
+ "type": "relation",
+ "name": "internalLink",
+ "value": "s8alTXmpFR61",
+ "isInheritable": false,
+ "position": 40
+ }
+ ],
+ "format": "markdown",
+ "dataFileName": "Widget Basics.md",
+ "attachments": []
+ },
+ {
+ "isClone": false,
+ "noteId": "M8IppdwVHSjG",
+ "notePath": [
+ "pOsGYCXsbNQG",
+ "CdNpE2pqjmI6",
+ "yIhgI5H7A2Sm",
+ "MgibgPcfeuGz",
+ "M8IppdwVHSjG"
+ ],
+ "title": "Right pane widget",
+ "notePosition": 30,
+ "prefix": null,
+ "isExpanded": false,
+ "type": "text",
+ "mime": "text/html",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "shareAlias",
+ "value": "right-pane-widget",
+ "isInheritable": false,
+ "position": 20
+ }
+ ],
+ "format": "markdown",
+ "dataFileName": "Right pane widget.md",
+ "attachments": []
+ },
+ {
+ "isClone": false,
+ "noteId": "VqGQnnPGnqAU",
+ "notePath": [
+ "pOsGYCXsbNQG",
+ "CdNpE2pqjmI6",
+ "yIhgI5H7A2Sm",
+ "MgibgPcfeuGz",
+ "VqGQnnPGnqAU"
+ ],
+ "title": "CSS",
+ "notePosition": 40,
+ "prefix": null,
+ "isExpanded": false,
+ "type": "text",
+ "mime": "text/html",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "shareAlias",
+ "value": "css",
+ "isInheritable": false,
+ "position": 20
+ }
+ ],
+ "format": "markdown",
+ "dataFileName": "CSS.md",
+ "attachments": []
}
]
},
{
"isClone": false,
- "noteId": "7kZPMD0uFwkH",
+ "noteId": "es8OU2GuguFU",
"notePath": [
"pOsGYCXsbNQG",
"CdNpE2pqjmI6",
- "es8OU2GuguFU",
- "7kZPMD0uFwkH"
+ "yIhgI5H7A2Sm",
+ "es8OU2GuguFU"
],
- "title": "Downloading responses from Google Forms",
+ "title": "Examples",
"notePosition": 20,
"prefix": null,
"isExpanded": false,
@@ -14772,49 +14885,182 @@
{
"type": "label",
"name": "shareAlias",
- "value": "responses-from-google-forms",
+ "value": "examples",
"isInheritable": false,
"position": 20
- }
- ],
- "format": "markdown",
- "dataFileName": "Downloading responses from Goo.md",
- "attachments": []
- },
- {
- "isClone": false,
- "noteId": "DL92EjAaXT26",
- "notePath": [
- "pOsGYCXsbNQG",
- "CdNpE2pqjmI6",
- "es8OU2GuguFU",
- "DL92EjAaXT26"
- ],
- "title": "Using promoted attributes to configure scripts",
- "notePosition": 30,
- "prefix": null,
- "isExpanded": false,
- "type": "text",
- "mime": "text/html",
- "attributes": [
+ },
{
"type": "label",
- "name": "shareAlias",
- "value": "promoted-attributes-config",
+ "name": "iconClass",
+ "value": "bx bx-code-alt",
"isInheritable": false,
- "position": 20
+ "position": 30
}
],
"format": "markdown",
- "dataFileName": "Using promoted attributes to c.md",
- "attachments": [
+ "attachments": [],
+ "dirFileName": "Examples",
+ "children": [
{
- "attachmentId": "7P3jzVEa1mk7",
- "title": "image.png",
- "role": "image",
- "mime": "image/png",
- "position": 10,
- "dataFileName": "Using promoted attributes .png"
+ "isClone": false,
+ "noteId": "TjLYAo3JMO8X",
+ "notePath": [
+ "pOsGYCXsbNQG",
+ "CdNpE2pqjmI6",
+ "yIhgI5H7A2Sm",
+ "es8OU2GuguFU",
+ "TjLYAo3JMO8X"
+ ],
+ "title": "\"New Task\" launcher button",
+ "notePosition": 10,
+ "prefix": null,
+ "isExpanded": false,
+ "type": "text",
+ "mime": "text/html",
+ "attributes": [
+ {
+ "type": "relation",
+ "name": "internalLink",
+ "value": "xYjQUYhpbUEW",
+ "isInheritable": false,
+ "position": 10
+ },
+ {
+ "type": "relation",
+ "name": "internalLink",
+ "value": "xYmIYSP6wE3F",
+ "isInheritable": false,
+ "position": 20
+ },
+ {
+ "type": "relation",
+ "name": "internalLink",
+ "value": "6f9hih2hXXZk",
+ "isInheritable": false,
+ "position": 30
+ },
+ {
+ "type": "relation",
+ "name": "internalLink",
+ "value": "zEY4DaJG4YT5",
+ "isInheritable": false,
+ "position": 40
+ },
+ {
+ "type": "relation",
+ "name": "internalLink",
+ "value": "m1lbrzyKDaRB",
+ "isInheritable": false,
+ "position": 50
+ },
+ {
+ "type": "relation",
+ "name": "internalLink",
+ "value": "s8alTXmpFR61",
+ "isInheritable": false,
+ "position": 60
+ },
+ {
+ "type": "relation",
+ "name": "internalLink",
+ "value": "yIhgI5H7A2Sm",
+ "isInheritable": false,
+ "position": 70
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-task",
+ "isInheritable": false,
+ "position": 80
+ },
+ {
+ "type": "label",
+ "name": "shareAlias",
+ "value": "new-task-button",
+ "isInheritable": false,
+ "position": 90
+ }
+ ],
+ "format": "markdown",
+ "dataFileName": "New Task launcher button.md",
+ "attachments": [
+ {
+ "attachmentId": "9C2JA6tdtRpN",
+ "title": "image.png",
+ "role": "image",
+ "mime": "image/png",
+ "position": 10,
+ "dataFileName": "New Task launcher button_i.png"
+ }
+ ]
+ },
+ {
+ "isClone": false,
+ "noteId": "7kZPMD0uFwkH",
+ "notePath": [
+ "pOsGYCXsbNQG",
+ "CdNpE2pqjmI6",
+ "yIhgI5H7A2Sm",
+ "es8OU2GuguFU",
+ "7kZPMD0uFwkH"
+ ],
+ "title": "Downloading responses from Google Forms",
+ "notePosition": 20,
+ "prefix": null,
+ "isExpanded": false,
+ "type": "text",
+ "mime": "text/html",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "shareAlias",
+ "value": "responses-from-google-forms",
+ "isInheritable": false,
+ "position": 20
+ }
+ ],
+ "format": "markdown",
+ "dataFileName": "Downloading responses from Goo.md",
+ "attachments": []
+ },
+ {
+ "isClone": false,
+ "noteId": "DL92EjAaXT26",
+ "notePath": [
+ "pOsGYCXsbNQG",
+ "CdNpE2pqjmI6",
+ "yIhgI5H7A2Sm",
+ "es8OU2GuguFU",
+ "DL92EjAaXT26"
+ ],
+ "title": "Using promoted attributes to configure scripts",
+ "notePosition": 30,
+ "prefix": null,
+ "isExpanded": false,
+ "type": "text",
+ "mime": "text/html",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "shareAlias",
+ "value": "promoted-attributes-config",
+ "isInheritable": false,
+ "position": 20
+ }
+ ],
+ "format": "markdown",
+ "dataFileName": "Using promoted attributes to c.md",
+ "attachments": [
+ {
+ "attachmentId": "7P3jzVEa1mk7",
+ "title": "image.png",
+ "role": "image",
+ "mime": "image/png",
+ "position": 10,
+ "dataFileName": "Using promoted attributes .png"
+ }
+ ]
}
]
}
@@ -14822,162 +15068,76 @@
},
{
"isClone": false,
- "noteId": "GPERMystNGTB",
+ "noteId": "SPirpZypehBG",
"notePath": [
"pOsGYCXsbNQG",
"CdNpE2pqjmI6",
- "GPERMystNGTB"
+ "SPirpZypehBG"
],
- "title": "Events",
- "notePosition": 70,
+ "title": "Backend scripts",
+ "notePosition": 30,
"prefix": null,
"isExpanded": false,
"type": "text",
- "mime": "text/markdown",
+ "mime": "text/html",
"attributes": [
{
- "type": "relation",
- "name": "internalLink",
- "value": "CdNpE2pqjmI6",
- "isInheritable": false,
- "position": 10
- },
- {
- "type": "relation",
- "name": "internalLink",
- "value": "c5xB8m4g2IY6",
- "isInheritable": false,
- "position": 20
- },
- {
- "type": "relation",
- "name": "internalLink",
- "value": "zEY4DaJG4YT5",
+ "type": "label",
+ "name": "shareAlias",
+ "value": "backend-basics",
"isInheritable": false,
"position": 30
},
- {
- "type": "label",
- "name": "shareAlias",
- "value": "events",
- "isInheritable": false,
- "position": 10
- },
{
"type": "label",
"name": "iconClass",
- "value": "bx bx-rss",
+ "value": "bx bx-server",
"isInheritable": false,
- "position": 20
+ "position": 40
}
],
"format": "markdown",
- "dataFileName": "Events.md",
- "attachments": []
- },
- {
- "isClone": false,
- "noteId": "MgibgPcfeuGz",
- "notePath": [
- "pOsGYCXsbNQG",
- "CdNpE2pqjmI6",
- "MgibgPcfeuGz"
- ],
- "title": "Custom Widgets",
- "notePosition": 80,
- "prefix": null,
- "isExpanded": false,
- "type": "text",
- "mime": "text/markdown",
- "attributes": [
- {
- "type": "label",
- "name": "shareAlias",
- "value": "custom-widget",
- "isInheritable": false,
- "position": 20
- },
- {
- "type": "label",
- "name": "iconClass",
- "value": "bx bxs-widget",
- "isInheritable": false,
- "position": 30
- }
- ],
- "format": "markdown",
- "dataFileName": "Custom Widgets.md",
"attachments": [],
- "dirFileName": "Custom Widgets",
+ "dirFileName": "Backend scripts",
"children": [
{
"isClone": false,
- "noteId": "YNxAqkI5Kg1M",
+ "noteId": "fZ2IGYFXjkEy",
"notePath": [
"pOsGYCXsbNQG",
"CdNpE2pqjmI6",
- "MgibgPcfeuGz",
- "YNxAqkI5Kg1M"
+ "SPirpZypehBG",
+ "fZ2IGYFXjkEy"
],
- "title": "Word count widget",
+ "title": "Server-side imports",
"notePosition": 10,
"prefix": null,
"isExpanded": false,
"type": "text",
"mime": "text/html",
"attributes": [
- {
- "type": "relation",
- "name": "internalLink",
- "value": "6tZeKvSHEUiB",
- "isInheritable": false,
- "position": 10
- },
- {
- "type": "relation",
- "name": "internalLink",
- "value": "6f9hih2hXXZk",
- "isInheritable": false,
- "position": 20
- },
- {
- "type": "relation",
- "name": "internalLink",
- "value": "s8alTXmpFR61",
- "isInheritable": false,
- "position": 30
- },
{
"type": "label",
"name": "shareAlias",
- "value": "word-count",
+ "value": "server-imports",
"isInheritable": false,
- "position": 40
+ "position": 20
}
],
"format": "markdown",
- "dataFileName": "Word count widget.md",
- "attachments": [
- {
- "attachmentId": "JhM9NWfebzPi",
- "title": "image.png",
- "role": "image",
- "mime": "image/png",
- "position": 10,
- "dataFileName": "Word count widget_image.png"
- }
- ]
+ "dataFileName": "Server-side imports.md",
+ "attachments": []
},
{
"isClone": false,
- "noteId": "SynTBQiBsdYJ",
+ "noteId": "GPERMystNGTB",
"notePath": [
"pOsGYCXsbNQG",
"CdNpE2pqjmI6",
- "MgibgPcfeuGz",
- "SynTBQiBsdYJ"
+ "SPirpZypehBG",
+ "GPERMystNGTB"
],
- "title": "Widget Basics",
+ "title": "Events",
"notePosition": 20,
"prefix": null,
"isExpanded": false,
@@ -14987,34 +15147,41 @@
{
"type": "relation",
"name": "internalLink",
- "value": "zEY4DaJG4YT5",
+ "value": "CdNpE2pqjmI6",
"isInheritable": false,
"position": 10
},
{
"type": "relation",
"name": "internalLink",
- "value": "BFs8mudNFgCS",
+ "value": "c5xB8m4g2IY6",
"isInheritable": false,
"position": 20
},
{
"type": "relation",
"name": "internalLink",
- "value": "GLks18SNjxmC",
+ "value": "zEY4DaJG4YT5",
"isInheritable": false,
"position": 30
},
{
"type": "label",
"name": "shareAlias",
- "value": "widget-basics",
+ "value": "events",
+ "isInheritable": false,
+ "position": 10
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-rss",
"isInheritable": false,
"position": 20
}
],
"format": "markdown",
- "dataFileName": "Widget Basics.md",
+ "dataFileName": "Events.md",
"attachments": []
}
]
@@ -15028,7 +15195,7 @@
"GLks18SNjxmC"
],
"title": "Script API",
- "notePosition": 90,
+ "notePosition": 100,
"prefix": null,
"isExpanded": false,
"type": "text",
@@ -15191,7 +15358,7 @@
"vElnKeDNPSVl"
],
"title": "Logging",
- "notePosition": 100,
+ "notePosition": 110,
"prefix": null,
"isExpanded": false,
"type": "text",
diff --git a/docs/User Guide/User Guide/Advanced Usage/Advanced Showcases/Task Manager.md b/docs/User Guide/User Guide/Advanced Usage/Advanced Showcases/Task Manager.md
index 20cf37c5e..13a4a5d94 100644
--- a/docs/User Guide/User Guide/Advanced Usage/Advanced Showcases/Task Manager.md
+++ b/docs/User Guide/User Guide/Advanced Usage/Advanced Showcases/Task Manager.md
@@ -15,7 +15,7 @@ New tasks are created in the TODO note which has `~child:template` [relation](..
### Attributes
-Task template defines several [promoted attributes](../Attributes/Promoted%20Attributes.md) - todoDate, doneDate, tags, location. Importantly it also defines `~runOnAttributeChange` relation - [event](../../Scripting/Events.md) handler which is run on attribute change. This [script](../../Scripting.md) handles when e.g. we fill out the doneDate attribute - meaning the task is done and should be moved to "Done" note and removed from TODO, locations and tags.
+Task template defines several [promoted attributes](../Attributes/Promoted%20Attributes.md) - todoDate, doneDate, tags, location. Importantly it also defines `~runOnAttributeChange` relation - [event](../../Scripting/Backend%20scripts/Events.md) handler which is run on attribute change. This [script](../../Scripting.md) handles when e.g. we fill out the doneDate attribute - meaning the task is done and should be moved to "Done" note and removed from TODO, locations and tags.
### New task button
diff --git a/docs/User Guide/User Guide/Advanced Usage/Attributes/Labels.md b/docs/User Guide/User Guide/Advanced Usage/Attributes/Labels.md
index 1a90f31cb..cb68dab93 100644
--- a/docs/User Guide/User Guide/Advanced Usage/Attributes/Labels.md
+++ b/docs/User Guide/User Guide/Advanced Usage/Attributes/Labels.md
@@ -39,4 +39,4 @@ This is a list of labels that Trilium natively supports.
> [!TIP]
> Some labels presented here end with a `*`. That means that there are multiple labels with the same prefix, consult the specific page linked in the description of that label for more information.
-
Label
Description
disableVersioning
Disables automatic creation of Note Revisions for a particular note. Useful for e.g. large, but unimportant notes - e.g. large JS libraries used for scripting.
versioningLimit
Limits the maximum number of Note Revisions for a particular note, overriding the global settings.
calendarRoot
Marks the note which should be used as root for Day Notes. Only one should be marked as such.
archived
Hides notes from default search results and dialogs. Archived notes can optionally be hidden in the Note Tree.
excludeFromExport
Excludes this note and its children when exporting.
Scripts with this label won't be included into parent script execution.
sorted
Keeps child notes sorted by title alphabetically.
When given a value, it will sort by the value of another label instead. If one of the child notes doesn't have the specified label, the title will be used for them instead.
sortDirection
If sorted is applied, specifies the direction of the sort:
ASC, ascending (default)
DESC, descending
sortFoldersFirst
If sorted is applied, folders (notes with children) will be sorted as a group at the top, and the rest will be sorted.
top
If sorted is applied to the parent note, keeps given note on top in its parent.
hidePromotedAttributes
Hide Promoted Attributes on this note. Generally useful when defining inherited attributes, but the parent note doesn't need them.
readOnly
Marks a note to be always be read-only, if it's a supported note (text, code, mermaid).
Marks CSS notes which are loaded into the Trilium application and can thus be used to modify Trilium's looks. See Custom app-wide CSS for more info.
appTheme
Marks CSS notes which are full Trilium themes and are thus available in Trilium options. See Theme development for more information.
appThemeBase
Set to next, next-light, or next-dark to use the corresponding TriliumNext theme (auto, light or dark) as the base for a custom theme, instead of the legacy one. See Customize the Next theme for more information.
cssClass
Value of this label is then added as CSS class to the node representing given note in the Note Tree. This can be useful for advanced theming. Can be used in template notes.
iconClass
value of this label is added as a CSS class to the icon on the tree which can help visually distinguish the notes in the tree. Example might be bx bx-home - icons are taken from boxicons. Can be used in template notes.
pageSize
Specifies the number of items per page in Note List.
default inbox location for new notes - when you create a note using new note button in the sidebar, notes will be created as child notes in the note marked as with #inbox label.
Comma delimited names of relations which should be displayed/hidden in a Relation Map (both the note type and the Note Map (Link map, Tree map) general functionality).
titleTemplate
Default title of notes created as children of this note. This value is evaluated as a JavaScript string and thus can be enriched with dynamic content via the injected now and parentNote variables.
Examples:
\({parentNote.getLabel('authorName')}'s literary works
This note will appear in the selection of available template when creating new note. See Templates for more information.
toc
Controls the display of the Table of contents for a given note. #toc or #toc=show to always display the table of contents, #toc=false to always hide it.
color
defines color of the note in note tree, links etc. Use any valid CSS color value like 'red' or #a13d5f Note: this color may be automatically adjusted when displayed to ensure sufficient contrast with the background.
keyboardShortcut
Defines a keyboard shortcut which will immediately jump to this note. Example: 'ctrl+alt+e'. Requires frontend reload for the change to take effect.
keepCurrentHoisting
Opening this link won't change hoisting even if the note is not displayable in the current hoisted subtree.
executeButton
Title of the button which will execute the current code note
executeDescription
Longer description of the current code note displayed together with the execute button
excludeFromNoteMap
Notes with this label will be hidden from the Note Map.
newNotesOnTop
New notes will be created at the top of the parent note, not on the bottom.
Sets the view of child notes (e.g. grid or list). See Note List for more information.
\ No newline at end of file
+
Label
Description
disableVersioning
Disables automatic creation of Note Revisions for a particular note. Useful for e.g. large, but unimportant notes - e.g. large JS libraries used for scripting.
versioningLimit
Limits the maximum number of Note Revisions for a particular note, overriding the global settings.
calendarRoot
Marks the note which should be used as root for Day Notes. Only one should be marked as such.
archived
Hides notes from default search results and dialogs. Archived notes can optionally be hidden in the Note Tree.
excludeFromExport
Excludes this note and its children when exporting.
Scripts with this label won't be included into parent script execution.
sorted
Keeps child notes sorted by title alphabetically.
When given a value, it will sort by the value of another label instead. If one of the child notes doesn't have the specified label, the title will be used for them instead.
sortDirection
If sorted is applied, specifies the direction of the sort:
ASC, ascending (default)
DESC, descending
sortFoldersFirst
If sorted is applied, folders (notes with children) will be sorted as a group at the top, and the rest will be sorted.
top
If sorted is applied to the parent note, keeps given note on top in its parent.
hidePromotedAttributes
Hide Promoted Attributes on this note. Generally useful when defining inherited attributes, but the parent note doesn't need them.
readOnly
Marks a note to be always be read-only, if it's a supported note (text, code, mermaid).
Marks CSS notes which are loaded into the Trilium application and can thus be used to modify Trilium's looks. See Custom app-wide CSS for more info.
appTheme
Marks CSS notes which are full Trilium themes and are thus available in Trilium options. See Theme development for more information.
appThemeBase
Set to next, next-light, or next-dark to use the corresponding TriliumNext theme (auto, light or dark) as the base for a custom theme, instead of the legacy one. See Customize the Next theme for more information.
cssClass
Value of this label is then added as CSS class to the node representing given note in the Note Tree. This can be useful for advanced theming. Can be used in template notes.
iconClass
value of this label is added as a CSS class to the icon on the tree which can help visually distinguish the notes in the tree. Example might be bx bx-home - icons are taken from boxicons. Can be used in template notes.
pageSize
Specifies the number of items per page in Note List.
default inbox location for new notes - when you create a note using new note button in the sidebar, notes will be created as child notes in the note marked as with #inbox label.
Comma delimited names of relations which should be displayed/hidden in a Relation Map (both the note type and the Note Map (Link map, Tree map) general functionality).
titleTemplate
Default title of notes created as children of this note. This value is evaluated as a JavaScript string and thus can be enriched with dynamic content via the injected now and parentNote variables.
Examples:
\({parentNote.getLabel('authorName')}'s literary works
This note will appear in the selection of available template when creating new note. See Templates for more information.
toc
Controls the display of the Table of contents for a given note. #toc or #toc=show to always display the table of contents, #toc=false to always hide it.
color
defines color of the note in note tree, links etc. Use any valid CSS color value like 'red' or #a13d5f Note: this color may be automatically adjusted when displayed to ensure sufficient contrast with the background.
keyboardShortcut
Defines a keyboard shortcut which will immediately jump to this note. Example: 'ctrl+alt+e'. Requires frontend reload for the change to take effect.
keepCurrentHoisting
Opening this link won't change hoisting even if the note is not displayable in the current hoisted subtree.
executeButton
Title of the button which will execute the current code note
executeDescription
Longer description of the current code note displayed together with the execute button
excludeFromNoteMap
Notes with this label will be hidden from the Note Map.
newNotesOnTop
New notes will be created at the top of the parent note, not on the bottom.
Sets the view of child notes (e.g. grid or list). See Note List for more information.
\ No newline at end of file
diff --git a/docs/User Guide/User Guide/Advanced Usage/Attributes/Relations.md b/docs/User Guide/User Guide/Advanced Usage/Attributes/Relations.md
index 454e7d007..6e1e9aa1f 100644
--- a/docs/User Guide/User Guide/Advanced Usage/Attributes/Relations.md
+++ b/docs/User Guide/User Guide/Advanced Usage/Attributes/Relations.md
@@ -43,7 +43,7 @@ These relations are supported and used internally by Trilium.
| Label | Description |
| --- | --- |
-| `runOn*` | See Events |
+| `runOn*` | See Events |
| `template` | note's attributes will be inherited even without a parent-child relationship, note's content and subtree will be added to instance notes if empty. See documentation for details. |
| `inherit` | note's attributes will be inherited even without a parent-child relationship. See Templates for a similar concept. See Attribute Inheritance in the documentation. |
| `renderNote` | notes of type Render Note will be rendered using a code note (HTML or script) and it is necessary to point using this relation to which note should be rendered |
diff --git a/docs/User Guide/User Guide/Advanced Usage/Nightly release.md b/docs/User Guide/User Guide/Advanced Usage/Nightly release.md
new file mode 100644
index 000000000..c9c2aac09
--- /dev/null
+++ b/docs/User Guide/User Guide/Advanced Usage/Nightly release.md
@@ -0,0 +1,34 @@
+# Nightly release
+Nightly releases are versions built every day, containing the latest improvements and bugfixes, directly from the main development branch. These versions are generally useful in preparation for a release, to ensure that there are no significant bugs that need to be addressed first, or they can be used to confirm whether a particular bug is fixed or feature is well implemented.
+
+## Regarding the stability
+
+Despite being on a development branch, generally the main branch is pretty stable since PRs are tested before they are merged. If you notice any issues, feel free to report them either via a ticket or via the Matrix.
+
+## Downloading the nightly release manually
+
+Go to [github.com/TriliumNext/Trilium/releases/tag/nightly](https://github.com/TriliumNext/Trilium/releases/tag/nightly) and look for the artifacts starting with `TriliumNotes-main`. Choose the appropriate one for your platform (e.g. `windows-x64.zip`).
+
+Depending on your use case, you can either test the portable version or even use the installer.
+
+> [!NOTE]
+> If you choose the installable version (e.g. the .exe on Windows), it will replace your stable installation.
+
+> [!IMPORTANT]
+> By default, the nightly uses the same database as the production version. Generally you could easily downgrade if needed. However, if there are changes to the database or sync version, it will not be possible to downgrade without having to restore from a backup.
+
+## Automatically download and install the latest nightly
+
+This is pretty useful if you are a beta tester that wants to periodically update their version:
+
+On Ubuntu:
+
+```
+#!/usr/bin/env bash
+
+name=TriliumNotes-linux-x64-nightly.deb
+rm -f $name*
+wget https://github.com/TriliumNext/Trilium/releases/download/nightly/$name
+sudo apt-get install ./$name
+rm $name
+```
\ No newline at end of file
diff --git a/docs/User Guide/User Guide/Basic Concepts and Features/UI Elements/Launch Bar.md b/docs/User Guide/User Guide/Basic Concepts and Features/UI Elements/Launch Bar.md
index 795e02602..d0ba7aecf 100644
--- a/docs/User Guide/User Guide/Basic Concepts and Features/UI Elements/Launch Bar.md
+++ b/docs/User Guide/User Guide/Basic Concepts and Features/UI Elements/Launch Bar.md
@@ -56,7 +56,7 @@ Right click either the _Available launchers_ or _Visible launchers_ sections and
2. Optionally, set a `keyboardShortcut` to trigger the launcher.
3. **Custom Widget**
- Allows defining a custom widget to be rendered inside the launcher. See [Widget Basics](../../Scripting/Custom%20Widgets/Widget%20Basics.md) for more information.
+ Allows defining a custom widget to be rendered inside the launcher. See [Widget Basics](../../Scripting/Frontend%20Basics/Custom%20Widgets/Widget%20Basics.md) for more information.
4. **Spacers**
Launchers that create some distance between other launchers for better visual distinction.
diff --git a/docs/User Guide/User Guide/Scripting.md b/docs/User Guide/User Guide/Scripting.md
index f5724f8a3..54a08c16b 100644
--- a/docs/User Guide/User Guide/Scripting.md
+++ b/docs/User Guide/User Guide/Scripting.md
@@ -12,7 +12,7 @@ So we have frontend and backend, each with their own set of responsibilities, bu
## Use cases
-* "New Task" launcher button
+* "New Task" launcher button
## Action handler
@@ -34,7 +34,7 @@ You can see more scripting with explanation in Events.
+See Events.
## Script API
diff --git a/docs/User Guide/User Guide/Scripting/Events.md b/docs/User Guide/User Guide/Scripting/Backend scripts/Events.md
similarity index 78%
rename from docs/User Guide/User Guide/Scripting/Events.md
rename to docs/User Guide/User Guide/Scripting/Backend scripts/Events.md
index 6dbeeeba6..227acd5f1 100644
--- a/docs/User Guide/User Guide/Scripting/Events.md
+++ b/docs/User Guide/User Guide/Scripting/Backend scripts/Events.md
@@ -1,15 +1,15 @@
# Events
-[Script](../Scripting.md) notes can be triggered by events. Note that these are backend events and thus relation need to point to the "JS backend" code note.
+[Script](../../Scripting.md) notes can be triggered by events. Note that these are backend events and thus relation need to point to the "JS backend" code note.
## Global events
Global events are attached to the script note via label. Simply create e.g. "run" label with some of these values and script note will be executed once the event occurs.
-
Label
Description
run
Defines on which events script should run. Possible values are:
frontendStartup - when Trilium frontend starts up (or is refreshed), but not on mobile.
mobileStartup - when Trilium frontend starts up (or is refreshed), on mobile.
backendStartup - when Trilium backend starts up
hourly - run once an hour. You can use additional label runAtHour to specify at which hour, on the back-end.
daily - run once a day, on the back-end
runOnInstance
Specifies that the script should only run on a particular Trilium instance.
runAtHour
On which hour should this run. Should be used together with #run=hourly. Can be defined multiple times for more runs during the day.
+
Label
Description
run
Defines on which events script should run. Possible values are:
frontendStartup - when Trilium frontend starts up (or is refreshed), but not on mobile.
mobileStartup - when Trilium frontend starts up (or is refreshed), on mobile.
backendStartup - when Trilium backend starts up
hourly - run once an hour. You can use additional label runAtHour to specify at which hour, on the back-end.
daily - run once a day, on the back-end
runOnInstance
Specifies that the script should only run on a particular Trilium instance.
runAtHour
On which hour should this run. Should be used together with #run=hourly. Can be defined multiple times for more runs during the day.
## Entity events
-Other events are bound to some entity, these are defined as [relations](../Advanced%20Usage/Attributes.md) - meaning that script is triggered only if note has this script attached to it through relations (or it can inherit it).
+Other events are bound to some entity, these are defined as [relations](../../Advanced%20Usage/Attributes.md) - meaning that script is triggered only if note has this script attached to it through relations (or it can inherit it).
| Relation | Description |
| --- | --- |
diff --git a/docs/User Guide/User Guide/Scripting/Backend scripts/Server-side imports.md b/docs/User Guide/User Guide/Scripting/Backend scripts/Server-side imports.md
new file mode 100644
index 000000000..ddc795aa0
--- /dev/null
+++ b/docs/User Guide/User Guide/Scripting/Backend scripts/Server-side imports.md
@@ -0,0 +1,11 @@
+# Server-side imports
+Older versions of Trilium Notes allowed the use of Common.js module imports inside backend scripts, such as:
+
+```
+const isBetween = require('dayjs/plugin/isBetween')
+api.dayjs.extend(isBetween)
+```
+
+For newer versions, Node.js imports are **not officially supported anymore**, since we've added a bundler which makes it more difficult to reuse dependencies.
+
+Theoretically it's still possible to use imports by manually setting up a `node_modules` in the server directory via `npm` or `pnpm`.
\ No newline at end of file
diff --git a/docs/User Guide/User Guide/Scripting/Examples/New Task launcher button.md b/docs/User Guide/User Guide/Scripting/Examples/New Task launcher button.md
deleted file mode 100644
index 85e834b8b..000000000
--- a/docs/User Guide/User Guide/Scripting/Examples/New Task launcher button.md
+++ /dev/null
@@ -1,47 +0,0 @@
-# "New Task" launcher button
-In this example we are going to extend the functionality of Task Manager showcase (which comes by default with Trilium) by adding a button in the Launch Bar () to create a new task automatically and open it.
-
-## Creating the note
-
-1. First, create a new Code note type with the _JS frontend_ language.
-2. Define the `#run=frontendStartup` label in Attributes.
-
-## Content of the script
-
-Copy-paste the following script:
-
-```javascript
-api.addButtonToToolbar({
- title: "New task",
- icon: "task",
- shortcut: "alt+n",
- action: async () => {
- const taskNoteId = await api.runOnBackend(() => {
- const todoRootNote = api.getNoteWithLabel("taskTodoRoot");
- const resp = api.createTextNote(todoRootNote.noteId, "New task", "")
- return resp.note.noteId;
- });
-
- await api.waitUntilSynced();
- await api.activateNewNote(taskNoteId);
- }
-});
-```
-
-## Testing the functionality
-
-Since we set the script to be run on start-up, all we need to do is to [refresh the application](../../Troubleshooting/Refreshing%20the%20application.md).
-
-## Understanding how the script works
-
-
Here we identify a note with the label#taskTodoRoot. This is how the Task Manager showcase knows where to place all the different tasks.
Normally this might return a null value if no such note could be identified, but error handling is outside the scope of this example.
const resp = api.createTextNote(todoRootNote.noteId, "New task", "")
We create a new child note within the to-do root note (first argument) with the title “New task" (second argument) and no content by default (third argument).
await api.waitUntilSynced();
Back on the client, since we created a new note on the server, we now need to wait for the change to be reflected in the client.
await api.activateNewNote(taskNoteId);
Since we know the ID of the newly created note, all we have to do now is to show this note to the user.
\ No newline at end of file
diff --git a/docs/User Guide/User Guide/Scripting/Frontend Basics.md b/docs/User Guide/User Guide/Scripting/Frontend Basics.md
index 2557deed7..13c47823d 100644
--- a/docs/User Guide/User Guide/Scripting/Frontend Basics.md
+++ b/docs/User Guide/User Guide/Scripting/Frontend Basics.md
@@ -54,4 +54,4 @@ Conversely to scripts, widgets do have some specific requirements in order to wo
### Tutorial
-For more information on building widgets, take a look at [Widget Basics](Custom%20Widgets/Widget%20Basics.md).
\ No newline at end of file
+For more information on building widgets, take a look at [Widget Basics](Frontend%20Basics/Custom%20Widgets/Widget%20Basics.md).
\ No newline at end of file
diff --git a/docs/User Guide/User Guide/Scripting/Custom Widgets.md b/docs/User Guide/User Guide/Scripting/Frontend Basics/Custom Widgets.md
similarity index 100%
rename from docs/User Guide/User Guide/Scripting/Custom Widgets.md
rename to docs/User Guide/User Guide/Scripting/Frontend Basics/Custom Widgets.md
diff --git a/docs/Developer Guide/Developer Guide/Old documentation/Scripting/Widgets/CSS.md b/docs/User Guide/User Guide/Scripting/Frontend Basics/Custom Widgets/CSS.md
similarity index 100%
rename from docs/Developer Guide/Developer Guide/Old documentation/Scripting/Widgets/CSS.md
rename to docs/User Guide/User Guide/Scripting/Frontend Basics/Custom Widgets/CSS.md
diff --git a/docs/Developer Guide/Developer Guide/Old documentation/Scripting/Widgets/Right pane widget.md b/docs/User Guide/User Guide/Scripting/Frontend Basics/Custom Widgets/Right pane widget.md
similarity index 100%
rename from docs/Developer Guide/Developer Guide/Old documentation/Scripting/Widgets/Right pane widget.md
rename to docs/User Guide/User Guide/Scripting/Frontend Basics/Custom Widgets/Right pane widget.md
diff --git a/docs/User Guide/User Guide/Scripting/Custom Widgets/Widget Basics.md b/docs/User Guide/User Guide/Scripting/Frontend Basics/Custom Widgets/Widget Basics.md
similarity index 75%
rename from docs/User Guide/User Guide/Scripting/Custom Widgets/Widget Basics.md
rename to docs/User Guide/User Guide/Scripting/Frontend Basics/Custom Widgets/Widget Basics.md
index b6e2a95ca..474cba983 100644
--- a/docs/User Guide/User Guide/Scripting/Custom Widgets/Widget Basics.md
+++ b/docs/User Guide/User Guide/Scripting/Frontend Basics/Custom Widgets/Widget Basics.md
@@ -22,10 +22,10 @@ module.exports = new MyWidget();
To implement this widget:
1. Create a new `JS Frontend` note in Trilium and paste in the code above.
-2. Assign the `#widget` [attribute](../../Advanced%20Usage/Attributes.md) to the [note](../../Basic%20Concepts%20and%20Features/Notes.md).
+2. Assign the `#widget` [attribute](../../../Advanced%20Usage/Attributes.md) to the [note](../../../Basic%20Concepts%20and%20Features/Notes.md).
3. Restart Trilium or reload the window.
-To verify that the widget is working, open the developer tools (`Cmd` + `Shift` + `I`) and run `document.querySelector("#my-widget")`. If the element is found, the widget is functioning correctly. If `undefined` is returned, double-check that the [note](../../Basic%20Concepts%20and%20Features/Notes.md) has the `#widget` [attribute](../../Advanced%20Usage/Attributes.md).
+To verify that the widget is working, open the developer tools (`Cmd` + `Shift` + `I`) and run `document.querySelector("#my-widget")`. If the element is found, the widget is functioning correctly. If `undefined` is returned, double-check that the [note](../../../Basic%20Concepts%20and%20Features/Notes.md) has the `#widget` [attribute](../../../Advanced%20Usage/Attributes.md).
### Step 2: Adding an UI Element
@@ -85,7 +85,7 @@ After reloading Trilium, the button should now appear at the bottom left of the
### Step 4: Adding User Interaction
-Let’s make the button interactive by showing a message when it’s clicked. We'll use the `api.showMessage` method from the [Script API](../Script%20API.md).
+Let’s make the button interactive by showing a message when it’s clicked. We'll use the `api.showMessage` method from the [Script API](../../Script%20API.md).
```
class MyWidget extends api.BasicWidget {
@@ -108,4 +108,11 @@ class MyWidget extends api.BasicWidget {
module.exports = new MyWidget();
```
-Reload the application one last time. When you click the button, a "Hello World!" message should appear, confirming that your widget is fully functional.
\ No newline at end of file
+`parentWidget()` can be given the following values:
+
+* `left-pane` - This renders the widget on the left side of the screen where the note tree lives.
+* `center-pane` - This renders the widget in the center of the layout in the same location that notes and splits appear.
+* `note-detail-pane` - This renders the widget _with_ the note in the center pane. This means it can appear multiple times with splits.
+* `right-pane` - This renders the widget to the right of any opened notes.
+
+[Reload](../../../Troubleshooting/Refreshing%20the%20application.md) the application one last time. When you click the button, a "Hello World!" message should appear, confirming that your widget is fully functional.
\ No newline at end of file
diff --git a/docs/User Guide/User Guide/Scripting/Custom Widgets/Word count widget.md b/docs/User Guide/User Guide/Scripting/Frontend Basics/Custom Widgets/Word count widget.md
similarity index 88%
rename from docs/User Guide/User Guide/Scripting/Custom Widgets/Word count widget.md
rename to docs/User Guide/User Guide/Scripting/Frontend Basics/Custom Widgets/Word count widget.md
index ad8c1c351..8b6be5684 100644
--- a/docs/User Guide/User Guide/Scripting/Custom Widgets/Word count widget.md
+++ b/docs/User Guide/User Guide/Scripting/Frontend Basics/Custom Widgets/Word count widget.md
@@ -1,8 +1,8 @@
# Word count widget
> [!TIP]
-> This widget is also present in new installations in the Demo Notes.
+> This widget is also present in new installations in the Demo Notes.
-Create a Code note of type JS frontend and **give it a** `#widget` **label**.
+Create a Code note of type JS frontend and **give it a** `#widget` **label**.
```
/*
@@ -82,7 +82,7 @@ class WordCountWidget extends api.NoteContextAwareWidget {
module.exports = new WordCountWidget();
```
-After you make changes it is necessary to [restart Trilium](../../Troubleshooting/Refreshing%20the%20application.md) so that the layout can be rebuilt.
+After you make changes it is necessary to [restart Trilium](../../../Troubleshooting/Refreshing%20the%20application.md) so that the layout can be rebuilt.
At the bottom of the note you can see the resulting widget:
diff --git a/docs/User Guide/User Guide/Scripting/Custom Widgets/Word count widget_image.png b/docs/User Guide/User Guide/Scripting/Frontend Basics/Custom Widgets/Word count widget_image.png
similarity index 100%
rename from docs/User Guide/User Guide/Scripting/Custom Widgets/Word count widget_image.png
rename to docs/User Guide/User Guide/Scripting/Frontend Basics/Custom Widgets/Word count widget_image.png
diff --git a/docs/User Guide/User Guide/Scripting/Examples/Downloading responses from Goo.md b/docs/User Guide/User Guide/Scripting/Frontend Basics/Examples/Downloading responses from Goo.md
similarity index 100%
rename from docs/User Guide/User Guide/Scripting/Examples/Downloading responses from Goo.md
rename to docs/User Guide/User Guide/Scripting/Frontend Basics/Examples/Downloading responses from Goo.md
diff --git a/docs/User Guide/User Guide/Scripting/Frontend Basics/Examples/New Task launcher button.md b/docs/User Guide/User Guide/Scripting/Frontend Basics/Examples/New Task launcher button.md
new file mode 100644
index 000000000..6740c047f
--- /dev/null
+++ b/docs/User Guide/User Guide/Scripting/Frontend Basics/Examples/New Task launcher button.md
@@ -0,0 +1,47 @@
+# "New Task" launcher button
+In this example we are going to extend the functionality of Task Manager showcase (which comes by default with Trilium) by adding a button in the Launch Bar () to create a new task automatically and open it.
+
+## Creating the note
+
+1. First, create a new Code note type with the _JS frontend_ language.
+2. Define the `#run=frontendStartup` label in Attributes.
+
+## Content of the script
+
+Copy-paste the following script:
+
+```javascript
+api.addButtonToToolbar({
+ title: "New task",
+ icon: "task",
+ shortcut: "alt+n",
+ action: async () => {
+ const taskNoteId = await api.runOnBackend(() => {
+ const todoRootNote = api.getNoteWithLabel("taskTodoRoot");
+ const resp = api.createTextNote(todoRootNote.noteId, "New task", "")
+ return resp.note.noteId;
+ });
+
+ await api.waitUntilSynced();
+ await api.activateNewNote(taskNoteId);
+ }
+});
+```
+
+## Testing the functionality
+
+Since we set the script to be run on start-up, all we need to do is to [refresh the application](../../../Troubleshooting/Refreshing%20the%20application.md).
+
+## Understanding how the script works
+
+
Here we identify a note with the label#taskTodoRoot. This is how the Task Manager showcase knows where to place all the different tasks.
Normally this might return a null value if no such note could be identified, but error handling is outside the scope of this example.
const resp = api.createTextNote(todoRootNote.noteId, "New task", "")
We create a new child note within the to-do root note (first argument) with the title “New task" (second argument) and no content by default (third argument).
await api.waitUntilSynced();
Back on the client, since we created a new note on the server, we now need to wait for the change to be reflected in the client.
await api.activateNewNote(taskNoteId);
Since we know the ID of the newly created note, all we have to do now is to show this note to the user.
\ No newline at end of file
diff --git a/docs/User Guide/User Guide/Scripting/Examples/New Task launcher button_i.png b/docs/User Guide/User Guide/Scripting/Frontend Basics/Examples/New Task launcher button_i.png
similarity index 100%
rename from docs/User Guide/User Guide/Scripting/Examples/New Task launcher button_i.png
rename to docs/User Guide/User Guide/Scripting/Frontend Basics/Examples/New Task launcher button_i.png
diff --git a/docs/User Guide/User Guide/Scripting/Examples/Using promoted attributes .png b/docs/User Guide/User Guide/Scripting/Frontend Basics/Examples/Using promoted attributes .png
similarity index 100%
rename from docs/User Guide/User Guide/Scripting/Examples/Using promoted attributes .png
rename to docs/User Guide/User Guide/Scripting/Frontend Basics/Examples/Using promoted attributes .png
diff --git a/docs/User Guide/User Guide/Scripting/Examples/Using promoted attributes to c.md b/docs/User Guide/User Guide/Scripting/Frontend Basics/Examples/Using promoted attributes to c.md
similarity index 100%
rename from docs/User Guide/User Guide/Scripting/Examples/Using promoted attributes to c.md
rename to docs/User Guide/User Guide/Scripting/Frontend Basics/Examples/Using promoted attributes to c.md
diff --git a/docs/User Guide/User Guide/Troubleshooting.md b/docs/User Guide/User Guide/Troubleshooting.md
index f439d1185..7ef4d2716 100644
--- a/docs/User Guide/User Guide/Troubleshooting.md
+++ b/docs/User Guide/User Guide/Troubleshooting.md
@@ -21,7 +21,7 @@ TRILIUM_START_NOTE_ID=root ./trilium
## Broken Script Prevents Application Startup
-If a custom script causes Triliumto crash, and it is set as a startup script or in an active [custom widget](Scripting/Custom%20Widgets.md), start Triliumin "safe mode" to prevent any custom scripts from executing:
+If a custom script causes Triliumto crash, and it is set as a startup script or in an active [custom widget](Scripting/Frontend%20Basics/Custom%20Widgets.md), start Triliumin "safe mode" to prevent any custom scripts from executing:
```
TRILIUM_SAFE_MODE=true ./trilium
* The _User Guide_ represents the user-facing documentation. This documentation can be browsed by users directly from within Trilium, by pressing F1.
* The _Developer's Guide_ represents a set of Markdown documents that present the internals of Trilium, for developers.
* _Release Notes_, this contains the change log for each released or soon-to-be-released version. The release notes are used automatically by the CI when releasing a version.
* The _Script API_, which is an automatically generated documentation for the front-end and back-end APIs for scripts.
-## Editing documentation
+## Location of the documentation
+
+All documentation is stored in the [Trilium](https://github.com/TriliumNext/Trilium) repository:
+
+* `docs/Developer Guide` contains Markdown documentation that can be modified either externally (using a Markdown editor, or internally using Trilium).
+* `docs/Release Notes` is also stored in Markdown format and can be freely edited.
+* `docs/Script API` contains auto-generated files and thus must not be modified.
+* `docs/User Guide` contains also Markdown-only documentation but must generally not be edited externally.
+ * The reason is that the `pnpm edit-docs:edit-docs` feature will not only import/export this documentation, but also generate the corresponding HTML documentation and meta structure in `src/public/app/doc_notes/en/User Guide`.
+ * It's theoretically possible to edit the Markdown files externally and then run `docs:edit` and trigger a change in order to build the documentation, but that would not be a very productive workflow.
+
+## Editing the documentation
There are two ways to modify documentation:
* Using a special mode of Trilium.
* By manually editing the files.
-### Using `docs:edit`
+### Using the `edit-docs` app
-To edit the documentation using Trilium, set up a working development environment and run the following commands:
-
-* On most operating systems, `npm run electron:switch` followed by `npm run docs:edit`
-* On NixOS, `npm run docs:edit-nix`.
-
-> [!NOTE]
-> `npm run docs:edit` acts very similar to `npm run electron:start` in the sense that you cannot both be editing documentation and starting a server. Using both `npm run electron:start` and `docs:edit` is possible, since they are using the same Electron instance.
+To edit the documentation using Trilium, set up a working development environment via Environment Setup and run the following command: `pnpm edit-docs:edit-docs`.
How it works:
@@ -50,24 +53,30 @@ Important aspects to consider:
* The Trilium import/export mechanism is not perfect, so if you make some modifications to the documentation using `docs:edit`, at the next import/export/import cycle some whitespace might get thrown in. It's generally safe to commit the changes as-is.
* Since we are importing Markdown, editing HTML and then exporting the HTML back to Markdown there might be some edge cases where the formatting is not properly preserved. Try to identify such cases and report them in order to get them fixed (this will benefit also the users).
-## Location of the documentation
+## Automation
-All documentation is stored in the [Notes](https://github.com/TriliumNext/Trilium) repository:
+The documentation is built via `apps/build-docs`:
-* `docs/Developer Guide` contains Markdown documentation that can be modified either externally (using a Markdown editor, or internally using Trilium).
-* `docs/Release Notes` is also stored in Markdown format and can be freely edited.
-* `docs/Script API` contains auto-generated files and thus must not be modified.
-* `docs/User Guide` contains also Markdown-only documentation but must generally not be edited externally.
- * The reason is that the `docs:edit` feature will not only import/export this documentation, but also generate the corresponding HTML documentation and meta structure in `src/public/app/doc_notes/en/User Guide`.
- * It's theoretically possible to edit the Markdown files externally and then run `docs:edit` and trigger a change in order to build the documentation, but that would not be a very productive workflow.
+1. The output directory is cleared.
+2. The User Guide and the Developer Guide are built.
+ 1. The documentation from the repo is archived and imported into an in-memory instance.
+ 2. The documentation is exported using the shared theme.
+3. The API docs (internal and ETAPI) are statically rendered via Redocly.
+4. The script API is generated via `typedoc`
+
+The `deploy-docs` workflow triggers the documentation build and uploads it to CloudFlare Pages.
## Updating the Script API
As mentioned previously, the Script API is not manually editable since it is auto-generated using TypeDoc.
-To update the API documentation, simply run `npm run docs:build`. Compare the changes (if any) and commit them.
+To update the API documentation, simply run `pnpm docs:build`. Compare the changes (if any) and commit them.
-Note that in order to simulate the environment a script would have, some fake source files (in the sense that they are only used for documentation) are being used as entrypoints for the documentation:
+Note that in order to simulate the environment a script would have, some fake source files (in the sense that they are only used for documentation) are being used as entrypoints for the documentation. Look for `backend_script_entrypoint` and `frontend_script_entrypoint` in `apps/build-docs/src`.
-* For back-end scripts, the script is located in `src/services/backend_script_entrypoint.ts`.
-* For front-end scripts, the script is located in `src/public/app/services/frontend_script_entrypoint.ts`.
\ No newline at end of file
+## Building locally
+
+In the Git root:
+
+* Run `pnpm docs:build`. The built documentation will be available in `site` at Git root.
+* To also run a webserver to test it, run `pnpm docs:preview` (this will not build the documentation) and navigate to `localhost:9000`.
\ No newline at end of file
diff --git a/docs/Developer Guide/Developer Guide/Old documentation/Documentation/Documentation references in th.md b/docs/Developer Guide/Developer Guide/Documentation/Documentation references in th.md
similarity index 69%
rename from docs/Developer Guide/Developer Guide/Old documentation/Documentation/Documentation references in th.md
rename to docs/Developer Guide/Developer Guide/Documentation/Documentation references in th.md
index 1c9a9fea9..79c1bd80e 100644
--- a/docs/Developer Guide/Developer Guide/Old documentation/Documentation/Documentation references in th.md
+++ b/docs/Developer Guide/Developer Guide/Documentation/Documentation references in th.md
@@ -13,6 +13,8 @@ https://triliumnext.github.io/Docs/Wiki/
There is a pattern of “?” buttons throughout the application which make use of the `data-help-page` attribute. Whenever these buttons are pressed, the user is redirected to the corresponding wiki page by prepending the wiki root URL to the `data-help-page` attribute.
+### Deprecated `help-page` attribute
+
Since the current wiki has a different structure than the original, for example to link to [https://github.com/TriliumNext/Docs/blob/main/Wiki/tree-concepts.md](https://github.com/TriliumNext/Docs/blob/main/Wiki/tree-concepts.md) the `data-help-page` attribute must be set to `tree-concepts.md`.
For links to headings, simply add the heading after the `.md`: `tree-concepts.md#prefix`
@@ -20,4 +22,12 @@ For links to headings, simply add the heading after the `.md`: `tree-concepts.md
You can identify those by looking for:
* `.attr("data-help-page"`
-* `data-help-page="`
\ No newline at end of file
+* `data-help-page="`
+
+### More modern `data-in-app-help` attribute
+
+Instead of opening in a web browser, this opens the help directly in the application in a split view. This is handled via the `data-in-app-help` attribute, where the value is the note ID of the help page without the `_help_` prefix.
+
+### React
+
+Use the `HelpButton` component in the same fashion as the `data-in-app-help` attribute.
\ No newline at end of file
diff --git a/docs/Developer Guide/Developer Guide/Old documentation/Documentation_image.png b/docs/Developer Guide/Developer Guide/Old documentation/Documentation_image.png
deleted file mode 100644
index 542bb7858..000000000
Binary files a/docs/Developer Guide/Developer Guide/Old documentation/Documentation_image.png and /dev/null differ
diff --git a/docs/Developer Guide/Developer Guide/Old documentation/Installation/Download latest nightly and in.md b/docs/Developer Guide/Developer Guide/Old documentation/Installation/Download latest nightly and in.md
deleted file mode 100644
index 0d5f2a2e4..000000000
--- a/docs/Developer Guide/Developer Guide/Old documentation/Installation/Download latest nightly and in.md
+++ /dev/null
@@ -1,12 +0,0 @@
-# Download latest nightly and install it
-On Ubuntu:
-
-```
-#!/usr/bin/env bash
-
-name=TriliumNotes-linux-x64-nightly.deb
-rm -f $name*
-wget https://github.com/TriliumNext/Trilium/releases/download/nightly/$name
-sudo apt-get install ./$name
-rm $name
-```
\ No newline at end of file
diff --git a/docs/Developer Guide/Developer Guide/Old documentation/Project maintenance/Updating dependencies/bettersqlite binaries.md b/docs/Developer Guide/Developer Guide/Old documentation/Project maintenance/Updating dependencies/bettersqlite binaries.md
deleted file mode 100644
index 5538646ca..000000000
--- a/docs/Developer Guide/Developer Guide/Old documentation/Project maintenance/Updating dependencies/bettersqlite binaries.md
+++ /dev/null
@@ -1,41 +0,0 @@
-# bettersqlite binaries
-### The native node bindings
-
-`better-sqlite3` has native Node bindings. With updates of `better-sqlite3`, but also of Electron and Node.js versions, these bindings need to be updated.
-
-Note that Electron and Node.js versions need different versions of these bindings, since Electron usually packs a different version of Node.js.
-
-During development, `npm install` tries to build or reuse prebuilt natives for the current Node.js version. This makes `npm run start-server` work out of the box. Trying to run `npm run start-electron` with these versions generally causes an error such as this:
-
-```
-Uncaught Exception:
-Error: The module '/Users/elian/Projects/Notes/node_modules/better-sqlite3/build/Release/better_sqlite3.node'
-was compiled against a different Node.js version using
-NODE_MODULE_VERSION 108. This version of Node.js requires
-NODE_MODULE_VERSION 116. Please try re-compiling or re-installing
-the module (for instance, using `npm rebuild` or `npm install`).
-```
-
-### How the natives are handled
-
-Locally, this can be fixed by rebuilding the binaries, which is what `npm run switch-electron` does, which uses `electron-rebuild` under the hood.
-
-When the deliveries are built (see Build deliveries locally), it is not feasible to rebuild the dependencies since we are building for multiple platforms. Luckily, `better-sqlite3` provides these prebuilt binaries from us, available as artifacts on [their GitHub releases page](https://github.com/WiseLibs/better-sqlite3/releases/).
-
-The build script manages the natives for `better-sqlite3` by keeping a copy of the `.node` file for every platform in `bin/better-sqlite3`.
-
-Whenever the version of `better-sqlite3` changes, the `.node` files must also be renewed based on their releases page. To simplify this process, a script was created in `bin/better-sqlite3/update.sh`.
-
-## How to update the natives
-
-The update script needs to know the version of Electron or Node.js for which to download the prebuilt binaries.
-
-If you get errors during download, check on the [releases page](https://github.com/WiseLibs/better-sqlite3/releases/) to ensure that this particular combination of Electron/Node actually exists for the given release.
-
-To determine the `NODE_MODULE_VERSION` that is required, look for `This version of Node.js requires`
-`NODE_MODULE_VERSION` in the error when starting Trilium via:
-
-* `npm run start-electron` (or run any Electron [delivery](../../../Building/Build%20deliveries%20locally.md)), case in which the `ELECTRON_VERSION` variable needs to be changed.
-* `npm run start-server` (or run the Linux server delivery), case in which the `NODE_VERSION` variable needs to be changed.
-
-Check which files got changed after running the update script and for each platform that got changed, test it locally via Build deliveries locally or via the CI.
\ No newline at end of file
diff --git a/docs/Developer Guide/Developer Guide/Old documentation/Scripting/Server-side imports.md b/docs/Developer Guide/Developer Guide/Old documentation/Scripting/Server-side imports.md
deleted file mode 100644
index c19366cee..000000000
--- a/docs/Developer Guide/Developer Guide/Old documentation/Scripting/Server-side imports.md
+++ /dev/null
@@ -1,16 +0,0 @@
-# Server-side imports
-Trilium Notes allowed the use of Common.js module imports inside backend scripts, such as:
-
-```
-const isBetween = require('dayjs/plugin/isBetween')
-api.dayjs.extend(isBetween)
-```
-
-For TriliumNext, the backend has been switched to use ESM which has a slightly more complicated syntax. Instead of `require` we now have `import` but which is asynchronous so it will require an `await`:
-
-```
-const isBetween = (await import("dayjs/plugin/isBetween")).default;
-api.dayjs.extend(isBetween);
-```
-
-Note that `.default` is also usually needed to obtain the same behaviour as a CJS import. When in doubt, use `console.log` to see the output of the value returned by `await import`.
\ No newline at end of file
diff --git a/docs/Developer Guide/Developer Guide/Old documentation/Scripting/Widgets.md b/docs/Developer Guide/Developer Guide/Old documentation/Scripting/Widgets.md
deleted file mode 100644
index 57de0ad15..000000000
--- a/docs/Developer Guide/Developer Guide/Old documentation/Scripting/Widgets.md
+++ /dev/null
@@ -1,33 +0,0 @@
-# Widgets
-To create a basic widget, simply create a code note with type “JS frontend”. Add the `#widget` label in order for it to be loaded at startup.
-
-```
-const template = ``;
-
-class MyWidget extends api.BasicWidget {
- get position() { return 1; }
- get parentWidget() { return "left-pane" }
-
- doRender() {
- this.$widget = $(template);
- return this.$widget;
- }
-}
-
-module.exports = new MyWidget();
-```
-
-`parentWidget()` can be given the following values:
-
-* `left-pane` - This renders the widget on the left side of the screen where the note tree lives.
-* `center-pane` - This renders the widget in the center of the layout in the same location that notes and splits appear.
-* `note-detail-pane` - This renders the widget _with_ the note in the center pane. This means it can appear multiple times with splits.
-* `right-pane` - This renders the widget to the right of any opened notes.
-
-* * *
-
-Reference:
-
-* [https://trilium.rocks/X7pxYpiu0lgU](https://trilium.rocks/X7pxYpiu0lgU)
-* [https://github.com/zadam/trilium/wiki/Widget-Basics](https://github.com/zadam/trilium/wiki/Widget-Basics)
-* [https://github.com/zadam/trilium/wiki/Frontend-Basics](https://github.com/zadam/trilium/wiki/Frontend-Basics)
\ No newline at end of file
diff --git a/docs/Developer Guide/Developer Guide/Old documentation/Sub-projects/CKEditor/Building the editor.md b/docs/Developer Guide/Developer Guide/Old documentation/Sub-projects/CKEditor/Building the editor.md
deleted file mode 100644
index 940617026..000000000
--- a/docs/Developer Guide/Developer Guide/Old documentation/Sub-projects/CKEditor/Building the editor.md
+++ /dev/null
@@ -1,21 +0,0 @@
-# Building the editor
-First, make sure Environment setup is set up.
-
-## Trigger the build
-
-```
-cd packages/ckeditor5-build-trilium
-yarn build
-```
-
-This will trigger a change in the `build` directory.
-
-## Copy the build artifact to the main repo
-
-Go to `packages/ckeditor5-build-balloon-trilium/build` and copy `ckeditor.js` and `ckeditor.js.map` to `libraries/ckeditor` in the `Notes` repository.
-
-An example shell command to copy it:
-
-```
-cp build/ckeditor.* ~/Projects/TriliumNext/Notes/libraries/ckeditor/
-```
\ No newline at end of file
diff --git a/docs/Developer Guide/Developer Guide/Old documentation/Sub-projects/CKEditor/Environment setup.md b/docs/Developer Guide/Developer Guide/Old documentation/Sub-projects/CKEditor/Environment setup.md
deleted file mode 100644
index 76819a12b..000000000
--- a/docs/Developer Guide/Developer Guide/Old documentation/Sub-projects/CKEditor/Environment setup.md
+++ /dev/null
@@ -1,26 +0,0 @@
-# Environment setup
-## Clone the repository
-
-To set up the repository:
-
-```
-git clone https://github.com/TriliumNext/trilium-ckeditor5.git
-```
-
-## Install dependencies
-
-First, install root dependencies:
-
-```
-cd trilium-ckeditor5
-yarn install
-```
-
-Secondly, install the Trilium build dependencies:
-
-```
-cd packages/ckeditor5-build-trilium
-yarn install
-```
-
-To trigger the build, see Building the editor.
\ No newline at end of file
diff --git a/docs/Developer Guide/Developer Guide/Old documentation/Sub-projects/CKEditor/Updating to a newer version of.md b/docs/Developer Guide/Developer Guide/Old documentation/Sub-projects/CKEditor/Updating to a newer version of.md
deleted file mode 100644
index 6e7808f67..000000000
--- a/docs/Developer Guide/Developer Guide/Old documentation/Sub-projects/CKEditor/Updating to a newer version of.md
+++ /dev/null
@@ -1,65 +0,0 @@
-# Updating to a newer version of CKEditor
-## Before updating
-
-Make sure that all the plugins are compatible with this version: Versions and external plugins. If not, they will need to be updated to the same version as the one you are updating, by altering their `package.json`.
-
-If the plugin is external to the Trilium organisation, it needs to be forked first.
-
-## Environment setup
-
-The first step is to add the CKEditor source as a remote. This only needs to be done once.
-
-```
-git remote add upstream ssh://git@github.com/ckeditor/ckeditor5.git
-git fetch upstream
-```
-
-## Update steps
-
-Due to how the repository is structured, updates to the CKEditor are a bit difficult.
-
-1. `git fetch upstream`
-2. Pick a version and merge with it: `git merge -X theirs v99.2.0`
-3. When there are complicated conflicts, sometimes it's easier to take everything from the target version instead, for a given path: `git checkout v99.2.0 -- "packages/ckeditor5-list/**"`.
-4. Go in `packages/ckeditor5-build-trilium/package.json` and run `node sync-version.js` to update the `package.json` with the new versions. Review and commit the change.
-5. Follow again the dependency setup in Environment setup, as they have changed.
-6. [Run the build](Building%20the%20editor.md) and check that it works.
-
-## Final steps
-
-1. Start the TriliumNext server
-2. If updated to a newer version of CKEditor, check type `CKEDITOR_VERSION` in the browser/Electron console to ensure that the correct version is used.
-3. Do a basic sanity check as well.
-4. Commit and push the change on both sides (in the `trilium-ckeditor5` repo and in the `Notes` repo).
-
-## Troubleshooting client side errors
-
-These errors might show up when testing the Trilium app:
-
-```
-ReferenceError: CKEditor is not defined
-```
-
-Usually this is a side effect of another error, check the logs carefully to see if there is any other related error (perhaps a `CKEditorError`).
-
-* * *
-
-```
-Uncaught error: Message: CKEditorError: ckeditor-duplicated-modules
-```
-
-Most likely cause is one of the external plugins is incompatible with this version.
-
-For example, to disable the Math plugin, go to `packages/ckeditor5-build-trilium/src/config.ts` and modify:
-
-```diff
--import Math from '@triliumnext/ckeditor5-math/src/math';
--import AutoformatMath from '@triliumnext/ckeditor5-math/src/autoformatmath';
-
-export const COMMON_PLUGINS = [
-- Math,
-- AutoformatMath,
-]
-```
-
-In this case, make sure to align the version of all the external plugins with the one you are updating to, usually by forking the external plugin and updating its versions.
\ No newline at end of file
diff --git a/docs/Developer Guide/Developer Guide/Old documentation/Sub-projects/CKEditor/Versions and external plugins.md b/docs/Developer Guide/Developer Guide/Old documentation/Sub-projects/CKEditor/Versions and external plugins.md
deleted file mode 100644
index 2fe124c31..000000000
--- a/docs/Developer Guide/Developer Guide/Old documentation/Sub-projects/CKEditor/Versions and external plugins.md
+++ /dev/null
@@ -1,8 +0,0 @@
-# Versions and external plugins
-## External plugins
-
-| | | |
-| --- | --- | --- |
-| trilium-ckeditor5 | 43.2.0 | |
-| `ckeditor5-math` | | See ckeditor5-math. |
-| | | |
\ No newline at end of file
diff --git a/docs/Developer Guide/Developer Guide/Old documentation/Sub-projects/ckeditor5-math.md b/docs/Developer Guide/Developer Guide/Old documentation/Sub-projects/ckeditor5-math.md
deleted file mode 100644
index 91b6b265f..000000000
--- a/docs/Developer Guide/Developer Guide/Old documentation/Sub-projects/ckeditor5-math.md
+++ /dev/null
@@ -1,29 +0,0 @@
-# ckeditor5-math
-
