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 a76bef1a28 docker should use webpacked frontend files, fixes #3322		2022-11-21 21:15:04 +01:00
.github	feature request desc	2021-12-21 22:47:31 +01:00
.idea	bulk actions WIP	2022-06-03 17:29:08 +02:00
.vscode	Add a VSCode debug configuration matching the start-server npm script (#1061 )	2020-05-31 12:40:53 +02:00
bin	use trilium version number in asset paths to avoid caching issues WIP	2022-10-26 23:50:54 +02:00
db	fix deleting note from task manager, closes #3239	2022-10-26 19:14:49 +02:00
docs	api docs	2022-11-12 20:40:40 +01:00
dump-db	use trilium version number in asset paths to avoid caching issues WIP	2022-10-26 23:50:54 +02:00
images	global note map should respect hoisting, #2365	2021-11-21 10:40:48 +01:00
libraries	enabled advanced list features, fixes #3308	2022-11-10 23:22:37 +01:00
spec	use trilium version number in asset paths to avoid caching issues WIP	2022-10-26 23:50:54 +02:00
spec-es6	added in-editor help for editing attributes	2020-08-21 23:08:53 +02:00
src	release 0.57.1-beta	2022-11-20 23:43:38 +01:00
test-etapi	basic auth etapi should require "etapi" username	2022-10-09 21:33:32 +02:00
.dockerignore
.gitignore	dev data directory should be relative	2022-04-15 14:51:14 +02:00
.gitpod.dockerfile
.gitpod.yml	use trilium version number in asset paths to avoid caching issues WIP	2022-10-26 23:50:54 +02:00
CODE_OF_CONDUCT	Create CODE_OF_CONDUCT	2022-02-12 13:17:49 +01:00
config-sample.ini	Add optional support to trust reverse proxies (via X-Forwarded-For)	2022-08-04 00:19:54 +02:00
docker-compose.yml	Update docker-compose sample to use node user home dir	2022-09-23 21:12:50 -04:00
Dockerfile	docker should use webpacked frontend files, fixes #3322	2022-11-21 21:15:04 +01:00
DockerHealthcheck.sh	Check both http and https in DockerHealthcheck	2022-10-20 23:29:23 -07:00
electron.js	moved auto read only options to code/text tabs	2022-11-18 21:27:25 +01:00
issue_template.md
jsdoc-conf.json
LICENSE
package-lock.json	library upgrades	2022-11-07 21:26:13 +01:00
package.json	release 0.57.1-beta	2022-11-20 23:43:17 +01:00
README-ZH_CN.md	Update README-ZH_CN.md	2022-02-24 20:38:01 +01:00
README.md	Fix spelling mistake	2022-10-28 19:20:43 -06:00
README.ru.md	Update README.ru.md	2022-02-24 20:38:29 +01:00
SECURITY.md
start-docker.sh	Fix docker image not exiting cleanly	2022-06-14 10:34:07 +02:00
trilium.iml	upgrades	2022-05-24 21:34:32 +02:00
webpack-desktop.config.js	use trilium version number in asset paths to avoid caching issues WIP	2022-10-26 23:50:54 +02:00
webpack-mobile.config.js	use trilium version number in asset paths to avoid caching issues WIP	2022-10-26 23:50:54 +02:00
webpack-setup.config.js	use trilium version number in asset paths to avoid caching issues WIP	2022-10-26 23:50:54 +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:

Ukraine is currently defending itself from Russian aggression, please consider donating to Ukrainian Army or humanitarian charities.

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
- there's a 3rd party service for hosting synchronisation server
Sharing (publishing) notes to public internet
Strong note encryption with per-note granularity
Sketching diagrams with built-in Excalidraw (note type "canvas")
Relation maps and link maps for visualizing notes and their relations
Scripting - see Advanced showcases
REST API for automation
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.

Trilium is also provided as a Flatpak:

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

Donating

You can donate using GitHub Sponsors, PayPal or Bitcoin (bitcoin:bc1qv3svjn40v89mnkre5vyvs2xw6y8phaltl385d2).

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.