Build your personal knowledge base with TriliumNext Notes
 
 
 
 
 
 
Go to file
Jin 86603573f0 fix ci build 2024-08-10 12:00:57 +07:00
.github fix ci build 2024-08-10 12:00:57 +07:00
.idea remove eslint 2024-03-06 07:17:51 +07:00
.vscode add electron-forge for all platforms 2024-08-05 18:47:57 +07:00
bin Merge branch 'TriliumNext:develop' into sql 2024-08-09 22:40:54 +07:00
db Update logo in demo document 2024-08-03 22:33:33 +07:00
docs docs: Add a few details about CKEditor 2024-08-02 00:20:17 +07:00
dump-db server-ts: Address requested changes 2024-03-30 10:49:40 +07:00
images Merge branch 'TriliumNext:develop' into sql 2024-08-09 22:40:54 +07:00
integration-tests client: Fix link to Wiki in F1 popup 2024-08-10 00:39:45 +07:00
libraries client: Update icon in CKEditor 2024-08-04 14:15:35 +07:00
spec server: Fix various imports 2024-07-24 20:31:26 +07:00
spec-es6 server: Fix various imports 2024-07-24 20:31:26 +07:00
src Merge pull request #294 from JYC333/sql 2024-08-10 10:56:38 +07:00
test-etapi allow specifying date created in the ETAPI, #4199 2023-08-30 00:11:32 +07:00
tests-examples integration-test: Initialize Playwright 2024-08-07 20:21:04 +07:00
.dockerignore ci: Fix docker build after macOS integration 2024-07-13 22:10:57 +07:00
.gitignore integration-test: Start implementing dedicated DB 2024-08-09 21:28:35 +07:00
.gitpod.dockerfile
.gitpod.yml Update .gitpod to Node 20 2024-07-17 00:01:33 +07:00
.prettierrc feat: Add prettier config (#165) 2024-05-31 12:04:42 +07:00
CODE_OF_CONDUCT
Dockerfile fix ci errors 2024-08-10 11:39:05 +07:00
LICENSE revert unintended license changes 2024-01-28 23:09:57 +07:00
README-ZH_CN.md update Chinese README 2024-07-19 15:00:53 +07:00
README.it.md found out the Italian README was actually already in here, and Translated all of the new stuff 2024-07-19 18:27:18 +07:00
README.ja.md Russian language README fixes 2024-07-17 18:16:58 +07:00
README.md docs: Add Dockerhub link to readme 2024-08-07 23:15:19 +07:00
README.ru.md Russian language README fixes 2024-07-17 18:16:58 +07:00
SECURITY.md Update SECURITY.md 2024-07-25 00:31:42 +07:00
_check_ts_progress.sh server-ts: Update progress script 2024-04-11 22:21:38 +07:00
config-sample.ini Fix typos 2023-06-23 00:27:04 +07:00
docker-compose.yml Remove erroneous backtick 2024-08-08 10:21:13 +07:00
docker_healthcheck.ts docker: Fix healthcheck & convert to TypeScript (closes #296) 2024-08-07 23:25:22 +07:00
electron.ts electron: Display TypeScript stack traces 2024-07-27 16:40:59 +07:00
forge.config.cjs fix ci errors 2024-08-10 11:39:05 +07:00
issue_template.md
jsdoc-conf.json preparing 0.59 without ocr/pdf, userguide, note ancillaries 2023-02-17 14:49:45 +07:00
loader-register.js fix ci build 2024-08-10 12:00:57 +07:00
nodemon.json server-esm: Use tsx instead of ts-node 2024-07-18 23:59:48 +07:00
package-lock.json fix ci errors 2024-08-10 11:39:05 +07:00
package.json fix ci build 2024-08-10 12:00:57 +07:00
playwright.config.ts integration-test: Create authentication setup 2024-08-09 00:41:55 +07:00
start-docker.sh change from gosu to just su 2024-08-08 15:17:02 +07:00
trilium.iml upgrades 2022-05-24 21:34:32 +07:00
tsconfig.json server: Use the TypeScript configuration that corresponds for Electron 2024-07-24 20:33:49 +07:00
webpack.config.ts build: Fix running webpack on ESM 2024-07-23 00:12:08 +07:00

README.md

TriliumNext Notes

English | Chinese | Russian | Japanese | Italian

TriliumNext Notes is an open-source, cross-platform hierarchical note taking application with focus on building large personal knowledge bases.

See screenshots for quick overview:

Trilium Screenshot

⚠️ Why TriliumNext?

The original Trilium project is in maintenance mode

💬 Discuss with us

Feel free to join our official conversations. We would love to hear what features, suggestions, or issues you may have!

  • Matrix (For synchronous discussions)
    • The General Matrix room is also bridged to XMPP
  • Github Discussions (For Asynchronous discussions)
  • Wiki (For common how-to questions and user guides)

🎁 Features

Check out the following third-party resources/communities for more TriliumNext related goodies:

🏗 Installation

Desktop

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

  • Download the binary release for your platform from the latest release page, unzip the package and run the trilium executable.
  • Access TriliumNext via the web interface of a server installation (see below)
    • Currently only the latest versions of Chrome & Firefox are supported (and tested).
  • (Coming Soon) TriliumNext will also be provided as a Flatpak

Mobile

To use TriliumNext on a mobile device:

  • Use a mobile web browser to access the mobile interface of a server installation (see below)
  • Use of a mobile app is not yet supported (see here) to track mobile improvements.

Server

To install TriliumNext on your own server (including via Docker from Dockerhub) follow the server installation docs.

📝 Documentation

See wiki for complete list of documentation pages.

You can also read Patterns of personal knowledge base to get some inspiration on how you might use TriliumNext.

💻 Contribute

Clone locally and run

npm install
npm run start-server

👏 Shoutouts

  • CKEditor 5 - best WYSIWYG editor on the market, very interactive and listening team
  • FancyTree - very feature rich tree library without real competition. TriliumNext Notes would not be the same without it.
  • CodeMirror - code editor with support for huge amount of languages
  • jsPlumb - visual connectivity library without competition. Used in relation maps and link maps

🤝 Support

You can support the original Trilium developer using GitHub Sponsors, PayPal or Bitcoin (bitcoin:bc1qv3svjn40v89mnkre5vyvs2xw6y8phaltl385d2). Support for the TriliumNext organization will be possible in the near future.

🔑 License

This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.