Skip to content

Latest commit

 

History

History
101 lines (68 loc) · 6.69 KB

README.md

File metadata and controls

101 lines (68 loc) · 6.69 KB

TriliumNext Notes

English | Chinese | Russian | Japanese | Italian

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:

Trilium Screenshot

⚠️ Why TriliumNext?

The original Trilium project is in maintenance mode

💬 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 General Matrix room is also bridged to XMPP
  • Github Discussions (For Asynchronous discussions)
  • Wiki (For common how-to questions and user guides)

🎁 Features

✨ Check out the following third-party resources/communities for more TriliumNext related goodies:

🏗 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 trilium executable.
  • 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

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. 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.