Skip to Content
PagesEditing Pages

Editing Pages

localWiki includes a rich text editor that supports Markdown shortcuts, so you can write documentation the way you already do in your code editors and READMEs.

Editor features

The editor supports standard formatting:

  • Bold, italic, strikethrough, and inline code
  • Headings (H1 through H3)
  • Bullet lists, numbered lists, and checklists
  • Code blocks with syntax highlighting
  • Blockquotes
  • Horizontal rules

Markdown shortcuts

Type Markdown syntax directly and it converts to rich text in real time:

# Heading 1 ## Heading 2 **bold text** - bullet item 1. numbered item ```code block``` > blockquote

You can also use the formatting toolbar at the top of the editor for point-and-click formatting.

Auto-save

Every change is persisted to the local SQLite database automatically. There is no manual save action. The editor debounces writes so rapid typing does not cause excessive disk I/O — changes flush within 150ms of the last keystroke, or immediately if 20 or more updates have buffered.

Local storage

Page content is stored as plaintext in a local SQLite database using Yjs CRDT state. The database directory is protected by OS file permissions, but page content itself is not encrypted at rest. For encrypted storage of sensitive credentials, use the secrets vault.

localWiki includes a built-in full-text search index (FTS5) that indexes your page content for fast searching. Use Ctrl+K / Cmd+K to open the search modal.

Slash commands

Type / in the editor to open the command palette. Available commands include inserting code blocks, adding checklists, and converting text to different heading levels.

Last updated on