da1cf4d6ed
|
||
|---|---|---|
| .github | ||
| .idea | ||
| .vscode | ||
| bin | ||
| db | ||
| docs | ||
| dump-db | ||
| images | ||
| integration-tests | ||
| libraries/ckeditor | ||
| spec | ||
| spec-es6 | ||
| src | ||
| test-etapi | ||
| tests-examples | ||
| translations | ||
| .dockerignore | ||
| .gitignore | ||
| .gitpod.dockerfile | ||
| .gitpod.yml | ||
| .npmrc | ||
| .prettierrc | ||
| CODE_OF_CONDUCT | ||
| Dockerfile | ||
| Dockerfile.alpine | ||
| LICENSE | ||
| README-ZH_CN.md | ||
| README.es.md | ||
| README.it.md | ||
| README.ja.md | ||
| README.md | ||
| README.ru.md | ||
| SECURITY.md | ||
| _check_ts_progress.sh | ||
| config-sample.ini | ||
| docker-compose.yml | ||
| docker_healthcheck.ts | ||
| electron-main.ts | ||
| electron.ts | ||
| forge.config.cjs | ||
| issue_template.md | ||
| jsdoc-conf.json | ||
| loader-register.js | ||
| nodemon.json | ||
| package-lock.json | ||
| package.json | ||
| playwright.config.ts | ||
| start-docker.sh | ||
| trilium.iml | ||
| tsconfig.json | ||
| webpack.config.ts | ||
README.md
TriliumNext Notes
English | Chinese | Russian | Japanese | Italian | Spanish
TriliumNext Notes is an open-source, cross-platform hierarchical note taking application with focus on building large personal knowledge bases.
See screenshots for quick overview:
⚠️ Why TriliumNext?
The original Trilium project is in maintenance mode
Migrating from Trilium?
There are no special migration steps to migrate from a zadam/Trilium instance to a TriliumNext/Notes instance. Just upgrade your Trilium instance to the latest version and install TriliumNext/Notes as usual
💬 Discuss with us
Feel free to join our official conversations. We would love to hear what features, suggestions, or issues you may have!
- Matrix (For synchronous discussions)
- The
GeneralMatrix room is also bridged to XMPP
- The
- Github Discussions (For Asynchronous discussions)
- Wiki (For common how-to questions and user guides)
🎁 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
- 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
✨ Check out the following third-party resources/communities for more TriliumNext related goodies:
- awesome-trilium for 3rd party themes, scripts, plugins and more.
- TriliumRocks! for tutorials, guides, and much more.
🏗 Installation
Desktop
To use TriliumNext on your desktop machine (Linux, MacOS, and Windows) you have a few options:
- Download the binary release for your platform from the latest release page, unzip the package and run the
triliumexecutable. - Access TriliumNext via the web interface of a server installation (see below)
- Currently only the latest versions of Chrome & Firefox are supported (and tested).
- (Coming Soon) TriliumNext will also be provided as a Flatpak
Mobile
To use TriliumNext on a mobile device:
- Use a mobile web browser to access the mobile interface of a server installation (see below)
- Use of a mobile app is not yet supported (see here) to track mobile improvements.
Server
To install TriliumNext on your own server (including via Docker from Dockerhub) follow the server installation docs.
📝 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 TriliumNext.
💻 Contribute
Code
git clone https://github.com/TriliumNext/Notes.git
cd Notes
npm install
npm run start-server
Documentation
Head on over to our Docs repo
👏 Shoutouts
- CKEditor 5 - best WYSIWYG editor on the market, very interactive and listening team
- FancyTree - very feature rich tree library without real competition. TriliumNext 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
🤝 Support
You can support the original Trilium developer using GitHub Sponsors, PayPal or Bitcoin (bitcoin:bc1qv3svjn40v89mnkre5vyvs2xw6y8phaltl385d2). Support for the TriliumNext organization will be possible in the near future.
🔑 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.