mirror of https://github.com/zadam/trilium.git synced 2024-09-20 23:55:59 +08:00

Build your personal knowledge base with Trilium Notes

Go to file

zadam c5e040c4a4 updated demo document with icon classes		2019-11-16 09:57:19 +01:00
.idea	fix migration script	2019-11-12 21:32:35 +01:00
bin	WS debugging messages and small changes	2019-10-24 23:02:29 +02:00
db	updated demo document with icon classes	2019-11-16 09:57:19 +01:00
docs	Merge branch 'stable'	2019-11-10 21:35:11 +01:00
images	use dev icon in dev environment	2019-07-21 09:14:56 +02:00
libraries	linking notes through CKEditor mentiones	2019-11-07 22:43:01 +01:00
src	updated demo document with icon classes	2019-11-16 09:57:19 +01:00
.dockerignore	Add .git, bin, and docs to the .dockerignore	2018-11-30 05:46:49 +00:00
.gitignore	fix docker build	2019-10-15 21:53:46 +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	Add host option (#588 )	2019-07-09 22:50:20 +02:00
docker-compose.yml	add example docker-compose	2019-04-14 15:24:35 +02:00
Dockerfile	WS debugging messages and small changes	2019-10-24 23:02:29 +02:00
electron.js	small fixes	2019-11-13 20:28:14 +01:00
issue_template.md	issue template	2019-01-21 19:55:07 +01: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	add move to dialog	2019-11-11 22:57:51 +01:00
package.json	release 0.37.0-beta	2019-11-14 23:12:28 +01:00
README.md	shoutouts in the README	2019-10-29 19:59:19 +01:00
trilium.iml	small refactorings	2019-10-20 13:09:00 +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 and images 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