Skip to main content

wit journal

Create and manage rich documentation pages for your repository. Journal provides a Notion-like experience for writing docs, READMEs, architecture decisions, onboarding guides, and more.

Basic Usage

Commands

List Pages

Create Pages

View Pages

Edit Pages

Organize Pages

Page Lifecycle

Version History

Delete Pages

Warning: Deleting a page also deletes all its children.

Page Status

Options

Examples

Create Documentation Structure

View Page Tree

Output:

View a Page

Output:

Search Documentation

Output:

Restore Previous Version

Web Interface

Journal pages are also accessible through the web interface at:

Tips

  • Use emojis as icons to make pages visually distinct
  • Create a clear hierarchy with parent pages
  • Keep pages focused on single topics
  • Use version history to track changes
  • Archive rather than delete to preserve history

See Also