mirror of
https://github.com/zadam/trilium.git
synced 2025-12-21 07:39:55 +01:00
docs(dev): update recent technical documentation
This commit is contained in:
4
docs/Developer Guide/Developer Guide/Building/Build information.md
vendored
Normal file
4
docs/Developer Guide/Developer Guide/Building/Build information.md
vendored
Normal 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.
|
||||
8
docs/Developer Guide/Developer Guide/Building/Docker.md
vendored
Normal file
8
docs/Developer Guide/Developer Guide/Building/Docker.md
vendored
Normal 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`).
|
||||
10
docs/Developer Guide/Developer Guide/Building/Live reload (HMR).md
vendored
Normal file
10
docs/Developer Guide/Developer Guide/Building/Live reload (HMR).md
vendored
Normal 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.
|
||||
Reference in New Issue
Block a user