Getting started

SDK

User guide
Toggle navigation of User guide
- Introduction
- Working with notes
  Toggle navigation of Working with notes
  - Sessions
  - Notes
  - Attributes
  - Branches
- Declarative notes: Notes as code
  Toggle navigation of Declarative notes: Notes as code
  - Example: Event tracker
- Trilium extensions

Tools

CLI tool (coming soon)

Reference

API
Toggle navigation of API
- trilium_alchemy
  Toggle navigation of trilium_alchemy
  - core
    Toggle navigation of core
    - note
      Toggle navigation of note
    - attribute
    - branch
    - declarative
      Toggle navigation of declarative
      - base
      - decorators
    - entity
    - exceptions
  - lib
    Toggle navigation of lib
  - tools

Development

API¶

This package provides:

A high level interface to interact with Trilium
Programmatic access to tooling for extensions and synchronization

Auto-generated code documentation is enabled by the autodoc2 Sphinx extension, a new and innovative documentation generator.

Custom templating and Sphinx doctree handling were developed to produce this API documentation. These will eventually be spun off into a separate project for reuse.