mirror of https://github.com/zadam/trilium.git synced 2024-12-27 01:34:05 +08:00

Build your personal knowledge base with Trilium Notes

Find a file

zadam 449081807e fix backend API's getNote, getBranch, getAttribute, closes #2230		2021-10-14 21:19:03 +02:00
.github	Add tag based multi arch docker build. (#2229 )	2021-10-14 20:42:27 +02:00
.idea	fix SQL console	2021-07-27 22:08:41 +02:00
.vscode	Add a VSCode debug configuration matching the start-server npm script (#1061 )	2020-05-31 12:40:53 +02:00
bin	docker image build/push is now handled by github actions	2021-10-14 20:49:48 +02:00
db	fix importing notePosition of directories	2021-10-08 22:31:35 +02:00
docs	updated API docs	2021-09-30 12:26:13 +02:00
images	added SVG icon	2021-10-13 19:54:26 +02:00
libraries	CKEditor 30 content styles	2021-10-08 18:17:17 +02:00
spec	converting note properties to methods	2021-05-18 20:56:49 +02:00
spec-es6	added in-editor help for editing attributes	2020-08-21 23:08:53 +02:00
src	fix backend API's getNote, getBranch, getAttribute, closes #2230	2021-10-14 21:19:03 +02:00
.dockerignore
.gitignore	fix setup of new document, closes #966	2020-04-14 21:57:42 +02:00
.gitpod.dockerfile	fix gitpod (#658 )	2019-10-14 11:55:12 +02:00
.gitpod.yml	upgrade node v14.17.6 for gitpod since optional chaining is required (#2219 )	2021-10-11 20:54:01 +02:00
config-sample.ini	config value to disable backups, closes #1533	2021-01-12 21:50:05 +01:00
docker-compose.yml	add example docker-compose	2019-04-14 15:24:35 +02:00
Dockerfile	revert of better sqlite3 dep for server build	2021-09-08 20:56:26 +02:00
electron.js	support OPML from MindManager, fixes #1862	2021-04-19 22:33:58 +02:00
issue_template.md	fix webpack buidl	2020-04-15 21:49:36 +02:00
jsdoc-conf.json
LICENSE
package-lock.json	docker image build/push is now handled by github actions	2021-10-14 20:49:48 +02:00
package.json	docker image build/push is now handled by github actions	2021-10-14 20:49:48 +02:00
README-ZH_CN.md	Fix translation errors (#2180 )	2021-09-27 14:37:29 +02:00
README.md	* Russian README added (#1794 )	2021-03-27 20:32:01 +01:00
README.ru.md	* Russian README added (#1794 )	2021-03-27 20:32:01 +01:00
SECURITY.md	Create SECURITY.md	2020-05-24 19:34:52 +02:00
TODO	added edited notes ribbon widget	2021-07-05 14:56:40 +02:00
trilium.iml	Merge remote-tracking branch 'origin/stable'	2021-04-18 12:39:19 +02:00
webpack-desktop.config.js	fix webpack buidl	2020-04-15 21:49:36 +02:00
webpack-mobile.config.js	fix webpack buidl	2020-04-15 21:49:36 +02:00
webpack-setup.config.js	fix webpack buidl	2020-04-15 21:49:36 +02:00

README.md

Trilium Notes

English | Chinese | Russian

Trilium Notes is a hierarchical note taking application with focus on building large personal knowledge bases. See screenshots for quick overview:

Features

Notes can be arranged into arbitrarily deep tree. Single note can be placed into multiple places in the tree (see cloning)
Rich WYSIWYG note editing including e.g. tables, images and math with markdown autoformat
Support for editing notes with source code, including syntax highlighting
Fast and easy navigation between notes, full text search and note hoisting
Seamless note versioning
Note attributes can be used for note organization, querying and advanced scripting
Synchronization with self-hosted sync server
Strong note encryption with per-note granularity
Relation maps and link maps for visualizing notes and their relations
Scripting - see Advanced showcases
Scales well in both usability and performance upwards of 100 000 notes
Touch optimized mobile frontend for smartphones and tablets
Night theme
Evernote and Markdown import & export
Web Clipper for easy saving of web content

Builds

Trilium is provided as either desktop application (Linux and Windows) or web application hosted on your server (Linux). Mac OS desktop build is available, but it is unsupported.

If you want to use Trilium on the desktop, download binary release for your platform from latest release, unzip the package and run trilium executable.
If you want to install Trilium on server, follow this page.
- Currently only recent Chrome and Firefox are supported (tested) browsers.

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 Trilium.

Contribute

Use a browser based dev environment

Or 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. Trilium 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

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.