mirror of
https://github.com/zadam/trilium.git
synced 2025-11-03 20:06:08 +01:00
94 lines
3.1 KiB
Markdown
94 lines
3.1 KiB
Markdown
|
# Trilium Notes Documentation
|
||
|
|
|
||
|
|
Welcome to the official documentation for **Trilium Notes** - a hierarchical note-taking application with a focus on building large personal knowledge bases.
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
## What is Trilium Notes?
|
||
|
|
|
||
|
|
Trilium Notes is a powerful, feature-rich note-taking application designed for building and managing extensive personal knowledge bases. It offers:
|
||
|
|
|
||
|
|
- **Hierarchical organization** with unlimited nesting of notes
|
||
|
|
- **Rich text editing** with markdown support
|
||
|
|
- **Powerful search** capabilities
|
||
|
|
- **Note relations** and attributes for semantic connections
|
||
|
|
- **Scripting support** for automation and customization
|
||
|
|
- **Synchronization** between devices
|
||
|
|
- **Encryption** for sensitive notes
|
||
|
|
- **Web clipper** for saving web content
|
||
|
|
|
||
|
|
## Quick Links
|
||
|
|
|
||
|
|
<div class="grid cards" markdown>
|
||
|
|
|
||
|
|
- :material-rocket-launch-outline: **[Quick Start Guide](User%20Guide/quick-start.md)**
|
||
|
|
|
||
|
|
Get up and running with Trilium in minutes
|
||
|
|
|
||
|
|
- :material-download: **[Installation](User%20Guide/installation.md)**
|
||
|
|
|
||
|
|
Download and install Trilium on your platform
|
||
|
|
|
||
|
|
- :material-docker: **[Docker Setup](User%20Guide/docker.md)**
|
||
|
|
|
||
|
|
Deploy Trilium using Docker containers
|
||
|
|
|
||
|
|
- :material-book-open-variant: **[User Guide](User%20Guide/index.md)**
|
||
|
|
|
||
|
|
Comprehensive guide to all features
|
||
|
|
|
||
|
|
- :material-code-braces: **[Script API](Script%20API/index.md)**
|
||
|
|
|
||
|
|
Automate and extend Trilium with scripting
|
||
|
|
|
||
|
|
- :material-wrench: **[Developer Guide](Developer%20Guide/index.md)**
|
||
|
|
|
||
|
|
Contributing and development documentation
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
## Features Overview
|
||
|
|
|
||
|
|
### Note Organization
|
||
|
|
- Create unlimited hierarchical note structures
|
||
|
|
- Clone notes to appear in multiple locations
|
||
|
|
- Use attributes and relations for metadata
|
||
|
|
- Template system for consistent note creation
|
||
|
|
|
||
|
|
### Content Types
|
||
|
|
- **Text notes** with rich formatting
|
||
|
|
- **Code notes** with syntax highlighting
|
||
|
|
- **Canvas notes** for drawing and diagrams
|
||
|
|
- **File attachments** of any type
|
||
|
|
- **Web view** for embedded content
|
||
|
|
- **Mermaid diagrams** support
|
||
|
|
|
||
|
|
### Advanced Features
|
||
|
|
- **Full-text search** with advanced operators
|
||
|
|
- **Note map** visualization
|
||
|
|
- **Day notes** for journaling
|
||
|
|
- **Book notes** for long-form content
|
||
|
|
- **Protected notes** with encryption
|
||
|
|
- **Note versioning** and history
|
||
|
|
|
||
|
|
### Automation & Integration
|
||
|
|
- JavaScript-based scripting
|
||
|
|
- Custom widgets and themes
|
||
|
|
- REST API for external integrations
|
||
|
|
- Web clipper browser extension
|
||
|
|
- Import/export in multiple formats
|
||
|
|
|
||
|
|
## Getting Help
|
||
|
|
|
||
|
|
- **[FAQ](support/faq.md)** - Frequently asked questions
|
||
|
|
- **[Troubleshooting](support/troubleshooting.md)** - Common issues and solutions
|
||
|
|
- **[Community Forum](https://github.com/triliumnext/trilium/discussions)** - Ask questions and share tips
|
||
|
|
- **[Issue Tracker](https://github.com/triliumnext/trilium/issues)** - Report bugs and request features
|
||
|
|
|
||
|
|
## Contributing
|
||
|
|
|
||
|
|
Trilium is open-source and welcomes contributions! Check out our [Contributing Guide](Developer%20Guide/contributing.md) to get started.
|
||
|
|
|
||
|
|
## License
|
||
|
|
|
||
|
|
Trilium Notes is licensed under [AGPL-3.0](https://github.com/triliumnext/trilium/blob/master/LICENSE).
|