![Zenith](docs/images/logo.svg)

# Zenith

**English** · [Русский](README.ru.md)

An all-in-one life organizer for [Obsidian](https://obsidian.md): a **Dashboard**, a
**Tasks** manager, a **Journal** of daily notes, and a **Content** tracker (books, movies,
shows, games…), built on a modular architecture so features can be toggled on and off without leaving your
vault.

![The dashboard: a clock, the weather, countdowns, tasks, the journal, the library and projects on one board](docs/images/screenshots/desktop-1-dashboard.png)

Your data stays as plain Markdown in your vault. Zenith reads and writes ordinary `.md`
files; there is no hidden database.

The interface speaks English, Russian and Simplified Chinese — Obsidian's language by default,
or the one set in *Settings → Zenith → General → Language*.

---

## Screenshots

| Tasks, beside their calendar | The journal |
| --- | --- |
| ![The task list, grouped by when things are due, next to the month's calendar](docs/images/screenshots/desktop-2-tasks.png) | ![The journal: a month of habits, the calendar and today's check-in](docs/images/screenshots/desktop-3-journal.png) |

| The library | Arranging the board |
| --- | --- |
| ![The content library as a grid of covers](docs/images/screenshots/desktop-4-library.png) | ![The board being arranged, with the list of widgets beside it](docs/images/screenshots/desktop-5-arrange.png) |

On a phone:

| | | | | |
| --- | --- | --- | --- | --- |
| ![The dashboard on a phone](docs/images/screenshots/mobile-1-dashboard.png) | ![Tasks on a phone](docs/images/screenshots/mobile-2-tasks.png) | ![The journal on a phone](docs/images/screenshots/mobile-3-journal.png) | ![The library on a phone](docs/images/screenshots/mobile-4-library.png) | ![Further down the board on a phone](docs/images/screenshots/mobile-5-board.png) |

Everything in the pictures is made up: they are of the demo vault that comes with each
[release](https://github.com/saifun0/obsidian-zenith/releases).

---

## Modules

| Module | What it does |
| --- | --- |
| **Dashboard** | Greeting, clock, weather, quick-add, and per-module summary widgets. |
| **Navigation** | A launcher widget and a side panel with a button for every Zenith view — extendable by any module — and buttons for the commands you run often. |
| **Search** | One line to find any view, action, task, project, library item or day's note, and to add a task. |
| **Editor** | Code blocks with the language's icon and name, a stripe in its colour, line numbers and a copy button. |
| **Tasks** | Parse, filter, search, group, create, edit, complete and delete tasks. |
| **Journal** | Daily notes on a calendar, with configurable habit / scale / number tracking and the day's tasks. |
| **Content** | A library of what you read, watch and play: a list by status or a grid, series, favourites, half-star ratings, progress, covers from the vault or a link, stats, and import from MyAnimeList / Goodreads / Letterboxd / Anixart. Works offline. |
| **Prayer** | Prayer times computed on the device, a countdown to the next one, and a record of what you prayed — kept in the daily note. |
| **Utilities** | Small dashboard cards you fill in yourself: a text or a note, a picture, links, recent notes, a quick note and a timer. |
| **Media Banner** | Show a GIF/image (from the vault or a URL) above the file-explorer tree, with a picker. |

Enable or disable modules in **Settings → Active Modules**. Modules load and unload
instantly — no Obsidian restart required.

---

## Network use

Zenith has no account, no telemetry and no server of its own. It goes online only for these,
and only while the feature is on:

- **Weather** — forecasts from `api.open-meteo.com`, and air quality from
  `air-quality-api.open-meteo.com` when that row is shown. Only the coordinates are sent.
- **Finding a place** — a city typed in settings is looked up at `geocoding-api.open-meteo.com`.
  Asked to use the device's own location, Zenith names it at `api.bigdatacloud.net`. A guess
  from your IP address, at `ipapi.co`, happens only if you switch it on.
- **Prayer times** — in calendar mode, a year of published times from `api.aladhan.com`, with
  the location rounded to about a kilometre. Calculated mode makes no requests.
- **Sync of note files** — only to the service you connect: Dropbox, OneDrive, an S3 bucket or
  a WebDAV server, and it can be end-to-end encrypted. Settings sync makes no requests of its
  own: it travels with the vault, however you already sync it — this file sync included.
- **Covers** given as a link load from that address, like any image in a note.
- **Updates** — when Obsidian starts, Zenith's `manifest.json` is read from
  `raw.githubusercontent.com` to see whether a newer version is out. Nothing is sent but the
  request itself; *Check for updates* in settings switches it off.

More in [Privacy](docs/en/privacy.md).

## Documentation

### Using Zenith

| Page | What is in it |
| --- | --- |
| [Features](docs/en/features.md) | Switching off what you don't use, module by module. |
| [Profiles](docs/en/profiles.md) | Templates, saving and undoing a setup, export and import. |
| [Notifications](docs/en/notifications.md) | Reminders, what happens to the ones you miss, quiet hours. |
| [Dashboard](docs/en/dashboard.md) | The board, its cards and arranging them; opening on startup, period progress, countdowns, life in weeks. |
| [Utilities](docs/en/utilities.md) | The text, picture, links, recent notes, quick note and timer cards. |
| [Vault helpers](docs/en/vault.md) | Folder and file icons, and the vault structure scaffold. |
| [Tasks](docs/en/tasks.md) | The task format: priorities, dates, tags, projects, and how ordering is stored. |
| [Journal](docs/en/journal.md) | Daily notes, habit / scale / number tracking, templates, and captured tasks. |
| [Prayer](docs/en/prayer.md) | Prayer times computed on the device, and what the daily note records. |
| [Search](docs/en/search.md) | Finding anything in Zenith from one line, adding from it, and the keys. |
| [Editor](docs/en/editor.md) | Code blocks: languages, line numbers, copying, and Code Styler. |
| [Side panel](docs/en/side-panel.md) | Zenith's views and your command buttons in the right sidebar, and arranging them. |
| [On a phone](docs/en/mobile.md) | Keeping views clear of the camera and of Obsidian's buttons: measured, or set by hand. |
| [Study](docs/en/study.md) | The class timetable: pasting it (an AI chat can make it from a photo), editing it, the card and reminders. |
| [Content](docs/en/content.md) | The content format, types and statuses, the library, and importing from MyAnimeList, Goodreads, Letterboxd and Anixart. |
| [Language](docs/en/language.md) | How Zenith picks a language, and how a module brings its own strings. |
| [Custom icons](docs/en/icons.md) | Icon packs, and what an SVG has to survive to be accepted. |

### Sync and privacy

| Page | What is in it |
| --- | --- |
| [Privacy](docs/en/privacy.md) | What leaves the device, and when. |
| [Setting up Dropbox](docs/en/dropbox.md) | Connecting Dropbox, and registering your own app if you would rather. |
| [Encrypted sync](docs/en/encryption.md) | The format, the key derivation, and what the server still learns. |

### Working on Zenith

| Page | What is in it |
| --- | --- |
| [Module API](docs/en/module-api.md) | Writing a module: the interface, dashboard widgets, launcher buttons and search. |
| [Development](docs/en/development.md) | Building, testing, linting and versioning this repository. |

---

## License

[MIT](LICENSE) © Saifun