tidy notebook guide

This page is for anyone who uses tidy notebook or runs it on their own server.

tidy notebook is a self-hosted Markdown notes application for you and the people you invite. Each account has its own notes. A note is a Markdown file in a folder you choose. Typing writes a draft on your device. Save creates one version on your server, and History keeps every version.

Writing notes

For the person who writes the notes.

• Getting started - your first sign-in and your first note.
• Joining an installation - accept an invitation, and leave again.
• Notes and folders - create, rename, move, and find your notes.
• Workspaces - keep personal notes and work notes apart.
• Markdown - the syntax the editor understands, and how Write mode and Read mode differ.
• Saving and history - what Save does, and how to bring an older version back.
• Working offline - what you can do with no connection.
• Daily notes - one note for each day, a template, and the calendar in the sidebar.
• Templates - copy a note that you keep as a template into another note, with the date and the time filled in.
• Trash - how a deleted note comes back.
• Published links - show one note, or one folder, to a person who has no account.
• Appearance and shortcuts - themes, light and dark, and the keyboard.
• Your own theme - import a theme file with your own colours.
• Spelling - the spell check of the editor, and how to turn it off.
• Export - take every note out as plain Markdown files.
• API keys and programs - connect a program to your account.
• Settings - each section of the Settings page, and where each choice is kept.

Hosting a server

For the person who runs the server.

• Quick start - the shortest path from a clone to the setup screen on your own machine.
• Self-hosting - the production installation.
• Configuration reference - every setting of the server and of its Compose file.
• Backup and restore - encrypted backups, and the restore test that makes them evidence.
• Upgrade - move to a new build and go back safely.
• Accounts and invitations - invite people and manage their accounts as an administrator.
• Security model - what the operator can see, and what the product does not protect against.

To report a security problem, read SECURITY.md.