Dima/Trilium
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

docs(dev): update recent technical documentation

Browse Source
This commit is contained in:
Elian Doran
2025-11-03 22:16:15 +02:00
parent 4a47ff2ea0
commit d9071f2d8e
85 changed files with 1449 additions and 1790 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/Developer Guide/Developer Guide/Building/Build information.md
Vendored
+4
View File
@@ -0,0 +1,4 @@
# Build information
* Provides context about when the build was made and the corresponding Git revision.
* The information is displayed to the client when going in the about dialog.
* The build information is hard-coded in `apps/server/src/services/build.ts`. This file is generated automatically via `chore:update-build-info` which itself is run automatically whenever making a build in the CI.
docs/Developer Guide/Developer Guide/Building/Docker.md
Vendored
+8
View File
@@ -0,0 +1,8 @@
# Docker
To build the server for Docker:
* Go to `apps/server` and run:
* `pnpm docker-build-debian` or
* `pnpm docker-build-alpine`.
* Similarly, to build the rootless versions: `pnpm docker-build-rootless-debian` or `pnpm docker-build-rootless-alpine`.
* To not only build but also run the Docker container, simply replace `docker-build` with `docker-start` (e.g. `pnpm docker-start-debian`).
docs/Developer Guide/Developer Guide/Building/Live reload (HMR).md
Vendored
+10
View File
@@ -0,0 +1,10 @@
# Live reload (HMR)
Trilium uses Vite's HMR (hot module reloading) mechanism.
## Server live reload
If running the server using `pnpm server:start`, the server will watch for changes. For React components, they will be hot-reloaded without requiring a refresh. For other services, it will reload the page.
## Desktop live reload
`pnpm desktop:start` acts the same as `pnpm server:start` with hot-reloading for client-side changes. Changes on the desktop side require a complete re-run of the `pnpm desktop:start` command.