mirror of https://github.com/zadam/trilium.git synced 2024-11-11 09:46:25 +08:00

Build your personal knowledge base with Trilium Notes

Find a file

zadam 6feb7ad1d5 selection clipping now supports images		2019-06-23 11:25:15 +02:00
.idea	fix creation of top level note, closes #501	2019-04-29 21:18:12 +02:00
bin	fix pngquant for linux-x64	2019-06-23 09:10:06 +02:00
db	schema update	2019-05-27 19:34:18 +02:00
docs	put tabContext into frontend script API	2019-05-29 21:48:48 +02:00
images	moved libraries and images out of src folder	2019-03-30 09:39:58 +01:00
libraries	fix fancytree navigation bug before official release, use unminified build in the meantime	2019-06-16 09:44:23 +02:00
src	selection clipping now supports images	2019-06-23 11:25:15 +02:00
.dockerignore	Add .git, bin, and docs to the .dockerignore	2018-11-30 05:46:49 +00:00
.gitignore	added jsdocs generated pages	2018-08-29 20:44:35 +02:00
.gitpod.yml	Added contribute section and gitpod config	2019-01-07 12:52:02 +00:00
config-sample.ini	delete attributes when deleting note	2018-08-15 15:27:22 +02:00
docker-compose.yml	add example docker-compose	2019-04-14 15:24:35 +02:00
Dockerfile	node updated to 12, electron to 6	2019-06-11 21:56:21 +02:00
electron.js	hide menu bar	2019-06-19 20:45:19 +02: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	added link map	2019-06-20 10:20:44 +02:00
package.json	release 0.33.2-beta	2019-06-20 09:39:11 +02:00
README.md	context menu items are now disabled when there are selected notes and the item does not support actions on multiple items	2019-06-17 20:34:00 +02:00
trilium.iml	label service refactoring + rename of doInTransaction to transactional	2018-04-07 13:03:16 -04: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

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