Architecture Overview

Cairnquire uses a Go application server as the primary runtime. The app is primarily server-rendered navigation and API endpoints with a lightweight vanilla JS client for editing and viewing documents.

  • Markdown documents are read from the source directory.
  • The current version is written into content-addressed storage.
  • Metadata lives in the local libsql-compatible database.
  • HTML is rendered server-side first.
  • A custom light-weight sync binary will make sure a local directory is synced with

See Getting Started for a feature-oriented overview.

Reference

Keyboard shortcuts

Anywhere

?
Show this reference
\
Focus document search
Esc
Close the active panel

Browse and read

HJKL
Move across columns and sections
Move across columns and sections
Enter
Open the selected document or edit a selected section
E
Open actions for the selected item
R
Rename the selected file
X
Archive the selected file

Comments

C
Open or close comments
A
Add a comment to the selected section
JK
Move between focused comments
R
Reply to the focused comment
E
Edit your focused comment
X
Resolve the focused thread
/Ctrl+Enter
Post or save a comment

Editor

/Ctrl+S
Save
Enter
Save and return to the document
:w
Save in Vim mode
:q
Return to the document in Vim mode
:wq/:x
Save and return in Vim mode

Single-key shortcuts pause while you are typing. Standard Vim motions remain available in the editor.