Home / Docs / Books

Books

Books

Each book is a self-contained writing project stored as a git repository.

What it does

Skribex organises your writing into books. Each book lives in its own folder with its own version history, so changes are tracked automatically. You can have multiple books and switch between them; the app remembers which one you were working on.

How to use it

Open Skribex for the first time — you land on the home page with a form to create your first book, or you can import the Treasure Island example book to explore Skribex with pre-populated content, entities, and relationships.

Return to Skribex — the home page shows all your books. Click one to open it in the editor. Your cursor position, scroll offset, sidebar state, and dark mode preference are all restored from your previous session.

Switch books — from the left sidebar, open the context menu at the bottom left to switch to a different book. You can also return to the home page via the Home navigation pill.

Notes

  • Book slugs are derived from the title (lowercase, hyphens, letters and digits only). A book titled "My Novel" becomes my-novel.
  • If a book with the same slug already exists, creation fails with a conflict error.
  • Session state (active book, editor scroll position, open panels) is stored separately from book content and does not affect git history.
  • Deleting a book must be done manually on disk — there is no delete endpoint in this version.

Quick start

Keyboard shortcuts

Cmd+/
Toggle distraction-free
Cmd+K
Omnibar (quick search)
Cmd+S
Save milestone
?
Show this help

Entity system

Type @ in the editor to mention a character, place, object, event, or concept. Skribex color-codes them and tracks relationships automatically. Click any mention to inspect the entity.

Temporal markers

Type ~ to place a time marker — absolute dates, relative ("two days later"), or named events. These anchor your story in a timeline visible on the mindmap.

Mindmap

The mindmap shows your story world as a graph: characters, locations, and their relationships. It builds itself as you write — no manual diagram work needed.