Documentation

Everything you need to understand, use, and extend TreeNotes. From quick starts to deep dives.

Documentation Sections

Getting Started

New to TreeNotes? Start here to learn the basics and get productive quickly.

  • Creating your first note
  • Organizing with folders
  • Basic editing
  • Keyboard shortcuts
  • Understanding the tree structure

User Guide

Comprehensive guide to all features and how to use them effectively.

  • Rich text editing
  • File attachments
  • Search and navigation
  • Favorites and recent notes
  • Version history

Sharing & Collaboration

Learn how to share notes and folders with others securely.

  • Sharing with users
  • Public share links
  • Permissions and access control
  • Collaboration best practices

Security & Privacy

Understand how TreeNotes protects your data with end-to-end encryption.

  • Encryption overview
  • Key management
  • Privacy guarantees
  • Security best practices

API Reference

Complete API documentation for developers building with TreeNotes.

  • Authentication
  • Node operations
  • Sharing endpoints
  • Error handling
  • SDK usage

Advanced Features

Power user features and tips for getting the most out of TreeNotes.

  • Templates
  • Export and import
  • Keyboard shortcuts
  • Workflow optimization

Getting Started

1. Create Your Account

Sign up for a free TreeNotes account. Your account is protected with end-to-end encryption, which means your password is used to generate encryption keys that only you control.

Sign Up Free

2. Explore the Welcome Tree

When you first log in, you'll see a welcome tree with example notes and templates. This helps you understand how TreeNotes works and gives you a starting point.

3. Create Your First Note

Click the "+ Note" button or press Ctrl+Alt+N to create your first note.

  • Give your note a descriptive name
  • Start typing your content
  • Use the formatting toolbar for rich text
  • Changes are saved automatically

4. Organize with Folders

Create folders to organize related notes. Drag and drop to reorganize your structure as your ideas evolve.

  • Click "Folder" or press Ctrl+Alt+Shift+N
  • Nest folders within folders for deeper organization
  • Drag notes and folders to reorganize

API Reference

TreeNotes provides a comprehensive REST API for developers. All API endpoints require authentication and use JSON for request and response bodies.

Authentication

TreeNotes uses JWT tokens stored in HttpOnly cookies for authentication. After logging in, all subsequent requests automatically include the authentication token.

POST /api/auth/login

Node Operations

Create, read, update, and delete nodes (notes and folders) in your tree structure.

GET /api/nodes - List all nodes
POST /api/nodes - Create a new node
PUT /api/nodes/:id - Update a node
DELETE /api/nodes/:id - Delete a node

SDK Usage

The TreeNotes client SDK provides a convenient way to interact with the API from JavaScript/TypeScript applications.

import { TreeNotesClient } from '@treenotes/client';

const client = new TreeNotesClient({
  apiBaseUrl: 'https://api.treenotes.com',
});

// Create a note
const note = await client.nodes.create({
  label: 'My Note',
  content: 'Note content...',
  parentNodeId: null
});

💡 Tip: For complete API documentation, check out the API docs in the admin panel or visit the Help Center for more examples.

Security & Privacy

TreeNotes is built with privacy and security as foundational principles. All your data is encrypted end-to-end, meaning only you can decrypt and read your notes.

End-to-End Encryption

Every piece of content—notes, folders, attachments, and metadata—is encrypted on your device before being sent to our servers. We use industry-standard encryption algorithms:

  • AES-GCM for symmetric encryption of content
  • X25519 for key exchange when sharing
  • Argon2 for password-based key derivation
  • HKDF-SHA512 for key wrapping

Zero-Knowledge Architecture

We cannot read your encrypted content. Even if we wanted to, we don't have access to your encryption keys. Your password never leaves your device in plaintext form.

Key Management

Each user has a master key derived from their password. This master key encrypts their private key, which is used for sharing. Each node has its own encryption key, wrapped for each authorized user.

Important: If you forget your password, we cannot recover your data. This is by design to ensure your privacy.

Sharing & Collaboration

Share your notes and folders with other TreeNotes users or create public share links for anyone to access.

Sharing with Users

Share folders or individual notes with other TreeNotes users. You can grant view-only or edit permissions.

  1. Select the note or folder you want to share
  2. Click the "Share" button in the toolbar
  3. Enter the email address of the recipient
  4. Choose permissions (view or edit)
  5. The recipient will receive access to the shared content

Public Share Links

Create anonymous share links that anyone can access, even without a TreeNotes account. You can optionally add password protection and expiration dates.

  • Generate a unique share link
  • Optionally set a password
  • Set an expiration date if needed
  • Share the link with anyone

Encryption in Sharing

When you share content, TreeNotes uses public key cryptography to wrap the node encryption keys for each recipient. This ensures that only authorized users can decrypt the shared content, maintaining end-to-end encryption even when sharing.

Need More Help?

Can't find what you're looking for? Check out our Help Center or get in touch with our support team.