Skip to main content
The Journal API allows you to create and manage Notion-like documentation pages for your repository.

Overview

Journal provides hierarchical documentation pages with version history, publish workflows, and search capabilities.

Endpoints

All journal endpoints are available via tRPC at api.journal.*

List Pages

Example:

Get Page

Example:

Create Page

Example:

Update Page

Creates a new version in the page history.

Delete Page

Warning: Also deletes all child pages.

Get Page Tree

Returns hierarchical tree structure. Example:

Search Pages

Searches both titles and content.

Publish Page

Changes status from draft to published and sets publishedAt.

Unpublish Page

Reverts status to draft.

Archive Page

Move Page

Get Page History

Example:

Restore Version

Types

JournalPage

JournalTreeNode

JournalVersion

Page Status

CLI Usage

Web Access

Journal pages are accessible at:

See Also