Skip to content
This repository was archived by the owner on Jun 24, 2025. It is now read-only.

Commit 02ac77d

Browse files
authored
Merge pull request #1922 from TriliumNext/docs/update-readme-for-pnmpm
feat(docs): add documentation links and updated pnpm commands to README
2 parents 1854d3e + c0f76b9 commit 02ac77d

File tree

1 file changed

+36
-5
lines changed

1 file changed

+36
-5
lines changed

README.md

Lines changed: 36 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,17 @@ There are no special migration steps to migrate from a zadam/Trilium instance to
2020

2121
Versions up to and including [v0.90.4](https://github.com/TriliumNext/Notes/releases/tag/v0.90.4) are compatible with the latest zadam/trilium version of [v0.63.7](https://github.com/zadam/trilium/releases/tag/v0.63.7). Any later versions of TriliumNext have their sync versions incremented.
2222

23+
## Documentation
24+
25+
We're currently in the progress of moving the documentation to in-app (hit the `F1` key within Trilium). As a result, there may be some missing parts until we've completed the migration. If you'd prefer to navigate through the documentation within GitHub, you can navigate the [User Guide](./docs/User%20Guide/User%20Guide/) documentation.
26+
27+
Below are some quick links for your convenience to navigate the documentation:
28+
- [Server installation](./docs/User%20Guide/User%20Guide/Installation%20&%20Setup/Server%20Installation.md)
29+
- [Docker installation](./docs/User%20Guide/User%20Guide/Installation%20&%20Setup/Server%20Installation/1.%20Installing%20the%20server/Using%20Docker.md)
30+
- [Upgrading TriliumNext](./docs/User%20Guide/User%20Guide/Installation%20%26%20Setup/Upgrading%20TriliumNext.md)
31+
- [Concepts and Features - Note](./docs/User%20Guide/User%20Guide/Basic%20Concepts%20and%20Features/Notes.md)
32+
33+
2334
## 💬 Discuss with us
2435

2536
Feel free to join our official conversations. We would love to hear what features, suggestions, or issues you may have!
@@ -63,7 +74,7 @@ Feel free to join our official conversations. We would love to hear what feature
6374

6475
To use TriliumNext on your desktop machine (Linux, MacOS, and Windows) you have a few options:
6576

66-
* Download the binary release for your platform from the [latest release page](https://github.com/TriliumNext/Notes/releases/latest), unzip the package and run the ```trilium``` executable.
77+
* Download the binary release for your platform from the [latest release page](https://github.com/TriliumNext/Notes/releases/latest), unzip the package and run the `trilium` executable.
6778
* Access TriliumNext via the web interface of a server installation (see below)
6879
* Currently only the latest versions of Chrome & Firefox are supported (and tested).
6980
* TriliumNext is also provided as a Flatpak, but not yet published on FlatHub.
@@ -90,18 +101,38 @@ You can also read [Patterns of personal knowledge base](https://triliumnext.gith
90101

91102
### Code
92103

104+
Download the repository, install dependencies using `pnpm` and then run the server (available at http://localhost:8080):
93105
```shell
94106
git clone https://github.com/TriliumNext/Notes.git
95107
cd Notes
96-
npm install
97-
npm run server:start
108+
pnpm install
109+
pnpm run server:start
110+
```
111+
112+
### Documentation
113+
114+
Download the repository, install dependencies using `pnpm` and then run the environment required to edit the documentation:
115+
```shell
116+
git clone https://github.com/TriliumNext/Notes.git
117+
cd Notes
118+
pnpm install
119+
pnpm nx run edit-docs:serve
120+
```
121+
122+
### Building the Executable
123+
Download the repository, install dependencies using `pnpm` and then build the desktop app for Windows:
124+
```shell
125+
git clone https://github.com/TriliumNext/Notes.git
126+
cd Notes
127+
pnpm install
128+
pnpm nx --project=desktop electron-forge:make -- --arch=x64 --platform=win32
98129
```
99130

100131
For more details, see the [development docs](https://github.com/TriliumNext/Notes/blob/develop/docs/Developer%20Guide/Developer%20Guide/Building%20and%20deployment/Running%20a%20development%20build.md).
101132

102-
### Documentation
133+
### Developer Documentation
103134

104-
See the [documentation guide](https://github.com/TriliumNext/Notes/blob/develop/docs/Developer%20Guide/Developer%20Guide/Documentation.md) for details.
135+
Please view the [documentation guide](./docs/Developer%20Guide/Developer%20Guide/Environment%20Setup.md) for details. If you have more questions, feel free to reach out via the links described in the "Discuss with us" section above.
105136

106137
## 👏 Shoutouts
107138

0 commit comments

Comments
 (0)