Repository navigation
Home
Devlog is a desktop app for keeping a running developer log. You write posts in a Slack-style WYSIWYG Markdown composer; Devlog stores them as plain Markdown files in a git repository and commits and pushes them for you. Features beyond notes (time tracking, window tracking, Jira worklogs, CMS timesheets) come as extensions that each devlog opts into.
This wiki has three audiences. Pick the section that fits.
| Page | What it covers |
|---|---|
| Getting Started | Install, create or open a devlog, first posts |
| Concepts | Canvases, surfaces, blocks, pages, tasks, todos |
Start with the overview, build the quickstart, then keep the reference pages open while you work.
| Page | What it covers |
|---|---|
| Extensions Overview | The model: what an extension is, where it comes from, how it is trusted |
| Extension Quickstart | A working extension, step by step: manifest, code, test, run, release |
| Extension Manifest | Every field of devlog-extension.json
|
| Extension API Reference |
DevlogContext (ctx): every namespace, method, permission and error |
| Extension Types | Every type an extension sees, field by field |
| Views and UI | Pages, status bar items, popovers and canvas-header views; the view message protocol |
| UI Kit Reference |
@devlog/ui: the bridge, hooks, components and CSS classes |
| Timesheet Destinations | Sending timesheets to Jira, CMS or your own system |
| Activity and Time Data | Pause/resume notices, idle detection, providing time and focus events |
| Sandbox and Permissions | What the runtime allows, grants, limits, unrestricted extensions |
| Testing Extensions |
@devlog/extension-api/testing: the in-memory ctx
|
| Built-in Extensions | devlog-time, devlog-focus, devlog-jira, devlog-cms as worked examples |
| API Versions | What arrived in each API version, 1.0 to 1.7 |
| Troubleshooting Extensions | Common errors and what they mean |
| Page | What it covers |
|---|---|
| Architecture | Processes, packages, where code lives |
| Storage Format | The repository layout and every file format |
| Core Library |
@devlog/core: DevlogStore, RepoIndex, SyncManager and friends |
| Extension Host Protocol | How the app runs an extension process and talks to it |
| Development | Building, testing, the smoke test, cutting a release |
This wiki describes Devlog 0.18.0, extension API 1.7.0, storage
format 4. The longer design notes live in the repository under
docs/; the wiki links to
them where they go deeper.
Devlog 0.18.0 · extension API 1.7.0 · storage format 4 · Repository · Design notes
Using Devlog
Writing extensions
- Overview
- Quickstart
- Manifest
- API Reference
- Types
- Views and UI
- UI Kit Reference
- Timesheet Destinations
- Activity and Time Data
- Sandbox and Permissions
- Testing
- Built-in Extensions
- API Versions
- Troubleshooting
Devlog internals