mirror of https://github.com/zadam/trilium.git synced 2024-11-11 01:23:57 +08:00

Build your personal knowledge base with Trilium Notes

Find a file

zadam d0efd67d5e grid view improvements, remembering grid/list status		2020-10-24 23:50:32 +02:00
.github	Create FUNDING.yml	2020-03-16 08:25:20 +01:00
.idea	add explicit button to show/hide right pane widgets, #1299	2020-10-12 23:15:53 +02:00
.vscode	Add a VSCode debug configuration matching the start-server npm script (#1061 )	2020-05-31 12:40:53 +02:00
bin	upgrading webpack fixes the issue with broken mobile frontend (and hacky fix which breaks desktop in turn)	2020-10-14 14:20:06 +02:00
db	fix demo document word count widget with contain: none	2020-10-10 21:08:28 +02:00
docs	return null for not found attribute, closes #1294	2020-10-08 22:08:58 +02:00
images	use dev icon in dev environment	2019-07-21 09:14:56 +02:00
libraries	frontend dayjs update	2020-10-23 21:24:16 +02:00
spec	test fixes	2020-09-23 21:05:26 +02:00
spec-es6	added in-editor help for editing attributes	2020-08-21 23:08:53 +02:00
src	grid view improvements, remembering grid/list status	2020-10-24 23:50:32 +02:00
.dockerignore	Add .git, bin, and docs to the .dockerignore	2018-11-30 05:46:49 +00:00
.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	fix gitpod (#658 )	2019-10-14 11:55:12 +02:00
config-sample.ini	allow disabling authentication for server version, closes #1132	2020-08-29 00:11:50 +02:00
docker-compose.yml	add example docker-compose	2019-04-14 15:24:35 +02:00
Dockerfile	transform setup.js to the webpacked version in the build	2020-05-08 20:50:53 +02:00
electron.js	use better-sqlite3	2020-06-17 23:03:46 +02:00
issue_template.md	fix webpack buidl	2020-04-15 21:49:36 +02:00
jsdoc-conf.json	jsdoc now doesn't include date into files to avoid unnecessary noise	2018-11-19 21:03:43 +01:00
LICENSE	licensing under AGPL v3	2017-12-10 21:13:39 -05:00
package-lock.json	frontend dayjs update	2020-10-23 21:24:16 +02:00
package.json	frontend dayjs update	2020-10-23 21:24:16 +02:00
README.md	Update README.md	2020-10-21 22:40:34 +02:00
SECURITY.md	Create SECURITY.md	2020-05-24 19:34:52 +02:00
trilium.iml	create note directly from mention linking	2020-05-09 14:25:27 +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

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