mirror of https://github.com/zadam/trilium.git synced 2024-11-10 17:13:45 +08:00

Build your personal knowledge base with Trilium Notes

Find a file

zadam 6f901e6852 use icons instead of plain text to differentiate between different paths in note paths widget		2021-03-10 23:11:48 +01:00
.github	Create FUNDING.yml	2020-03-16 08:25:20 +01:00
.idea	electron update	2020-11-10 22:54:03 +01:00
.vscode	Add a VSCode debug configuration matching the start-server npm script (#1061 )	2020-05-31 12:40:53 +02:00
bin	fix docker build	2020-10-27 19:39:54 +01:00
db	fixed saved note migration - need to be migrated as last, #1647	2021-02-16 21:40:17 +01:00
docs	add frontend API method openTabWithNote, #1645	2021-02-17 23:55:51 +01:00
images	use dev icon in dev environment	2019-07-21 09:14:56 +02:00
libraries	fancytree 2.38.0	2021-02-09 21:33:55 +01:00
spec	extra case sensitivity tests	2020-12-15 15:15:41 +01:00
spec-es6	added in-editor help for editing attributes	2020-08-21 23:08:53 +02:00
src	use icons instead of plain text to differentiate between different paths in note paths widget	2021-03-10 23:11:48 +01: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	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	Drop privileges (#1422 )	2020-11-15 20:51:47 +01: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	prevent cycles in resolving the notepath, fixes #1730	2021-03-10 22:54:55 +01:00
package.json	release 0.46.3-beta	2021-03-08 23:11:11 +01:00
README-ZH_CN.md	add chinese version README. (#1465 )	2020-11-27 08:37:08 +01:00
README.md	added license mention into the README noting AGPL v3+, #1708	2021-03-03 21:41:44 +01: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

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.