# 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](https://docs.tidynotebook.com/getting-started.md) - your first sign-in and your first
  note.
- [Joining an installation](https://docs.tidynotebook.com/joining.md) - accept an invitation, and leave
  again.
- [Notes and folders](https://docs.tidynotebook.com/notes-and-folders.md) - create, rename, move, and find
  your notes.
- [Workspaces](https://docs.tidynotebook.com/workspaces.md) - keep personal notes and work notes apart.
- [Markdown](https://docs.tidynotebook.com/markdown.md) - the syntax the editor understands, and how Write
  mode and Read mode differ.
- [Saving and history](https://docs.tidynotebook.com/saving-and-history.md) - what Save does, and how to
  bring an older version back.
- [Working offline](https://docs.tidynotebook.com/offline.md) - what you can do with no connection.
- [Daily notes](https://docs.tidynotebook.com/daily-notes.md) - one note for each day, a template, and the
  calendar in the sidebar.
- [Templates](https://docs.tidynotebook.com/templates.md) - copy a note that you keep as a template into
  another note, with the date and the time filled in.
- [Trash](https://docs.tidynotebook.com/trash.md) - how a deleted note comes back.
- [Published links](https://docs.tidynotebook.com/published-links.md) - show one note, or one folder, to a
  person who has no account.
- [Appearance and shortcuts](https://docs.tidynotebook.com/appearance-and-shortcuts.md) - themes, light and
  dark, and the keyboard.
- [Your own theme](https://docs.tidynotebook.com/custom-themes.md) - import a theme file with your own
  colours.
- [Spelling](https://docs.tidynotebook.com/spelling.md) - the spell check of the editor, and how to turn it
  off.
- [Export](https://docs.tidynotebook.com/export.md) - take every note out as plain Markdown files.
- [API keys and programs](https://docs.tidynotebook.com/api.md) - connect a program to your account.
- [Settings](https://docs.tidynotebook.com/settings.md) - each section of the Settings page, and where each
  choice is kept.

## Hosting a server

For the person who runs the server.

- [Quick start](https://docs.tidynotebook.com/quickstart.md) - the shortest path from a clone to the setup
  screen on your own machine.
- [Self-hosting](https://docs.tidynotebook.com/self-hosting.md) - the production installation.
- [Configuration reference](https://docs.tidynotebook.com/configuration.md) - every setting of the server
  and of its Compose file.
- [Backup and restore](https://docs.tidynotebook.com/backup-and-restore.md) - encrypted backups, and the
  restore test that makes them evidence.
- [Upgrade](https://docs.tidynotebook.com/upgrade.md) - move to a new build and go back safely.
- [Accounts and invitations](https://docs.tidynotebook.com/accounts.md) - invite people and manage their
  accounts as an administrator.
- [Security model](https://docs.tidynotebook.com/security-model.md) - what the operator can see, and what
  the product does not protect against.

To report a security problem, read [SECURITY.md](https://github.com/tidynotebook/tidynotebook/blob/main/SECURITY.md).