mirror of https://github.com/zadam/trilium.git synced 2024-09-21 16:16:04 +08:00

Build your personal knowledge base with Trilium Notes

Go to file

perissology 62b44e3549 use electron-builder for npm install This will build deps as required for electron as well as the os. This fixes the missing binding error for sqlite3 when trying to run the electron app after a fresh npm i		2019-01-08 06:50:48 -08:00
.idea	saving image	2018-11-08 11:08:16 +01:00
bin	lazy loading icon for both mobile and desktop	2018-12-30 21:13:35 +01:00
db	hoisting notes WIP	2018-12-11 21:53:56 +01:00
docs	updated API docs	2018-12-22 22:28:49 +01:00
src	stretch sync login token validity to 5 minutes #277	2019-01-07 23:29:56 +01: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
Dockerfile	Update Dockerfile	2019-01-07 21:21:23 +00:00
electron.js	generate local .desktop file so it shows among apps in linux desktop environments	2018-11-21 11:01:03 +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	responsive setup page	2019-01-05 21:49:40 +01:00
package.json	use electron-builder for npm install	2019-01-08 06:50:48 -08:00
README.md	Added contribute section and gitpod config	2019-01-07 12:52:02 +00: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 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, Windows, Mac) or web application hosted on your server (Linux).

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