Skip to content

Latest commit

 

History

History
132 lines (93 loc) · 5.52 KB

File metadata and controls

132 lines (93 loc) · 5.52 KB

Notebook guide

The btw-wiki notebook is a local browser interface over the current project's .wiki/ folder. Open it from Claude Code with:

/btw-wiki:notebook

It reads the live wiki, so newly saved pages appear after a refresh. The reader does not modify the wiki unless you explicitly choose Save to wiki in Ask.

Contents

Browse your wiki

The home screen groups every page by topic in a card grid. A resizable, collapsible sidebar provides the same topic navigation. Switch from Contents to Recently updated to rank pages by their Last updated date.

The Contents home — a card grid of every page, grouped by topic

Search

The live filter searches page contents as well as titles and shows matching snippets. Press ⌘K or / to open the command palette from anywhere.

The command palette searching page contents, with matching snippets

Follow links and backlinks

Links written as [[page-name]] are clickable in the reader. Because links use a page name instead of a path, pages can move between topic folders without breaking navigation. Each page also lists all pages that point to it under Referenced by.

A wiki page with clickable wiki-links and its Referenced by backlinks list

Explore the graph

The graph plots pages as nodes and [[wiki-links]] as edges. Node size reflects the number of connections, while color groups pages by topic.

Use the legend to show, hide, or isolate topics. Hover over a node to highlight its neighbors, or select it to inspect its summary, outgoing links, and backlinks. Drag nodes to rearrange them, scroll to zoom, and drag the background to pan.

The force-directed graph of pages connected by their wiki-links

A selected node's detail panel alongside the topic legend

Ask from the notebook

The Ask panel answers from your .wiki/ and turns cited [[page-name]] values into clickable links. Each response is graded by how well the wiki covered it: already in your wiki, partly in your wiki, or new. Chat history survives a refresh.

Use the provider selector to choose Auto (recommended), Codex, or Claude. Auto prefers the CLI that launched the notebook and falls back to the other provider when it is unavailable or signed out. Each answer shows which provider actually handled it. Both CLIs reuse their existing authentication; no separate API key is required.

Set BTW_WIKI_CODEX_MODEL or BTW_WIKI_CLAUDE_MODEL before launch to pin a provider-specific model. BTW_WIKI_ASK_MODEL remains a shared fallback.

The browser Ask panel with its Answer and Learn toggle

Ask about a passage

Highlight text anywhere in a page and an Ask about this button appears next to the selection. Clicking it opens Ask with the passage quoted above the input, so your question carries that context and the page it came from. The button only appears over the reading pane — inside the Ask panel itself there is nothing to quote, so it stays hidden. Clear the quote with the × on the banner.

Save an answer back into the wiki

When an answer adds something the wiki does not already have, a Save to wiki button appears under it. Nothing is written until you click it. The save runs a background scribe that files the material into topic pages, links them with [[wiki-links]], and updates index.md and log.md.

When it finishes, the answer reports exactly what changed: the pages it created and the pages it updated, each a link straight to that page. The list is derived from the wiki folder itself, so it reflects what was actually written. The sidebar refreshes at the same time.

An answer saved into the wiki, listing the pages it created and updated

Build a learning path

Switch to Learn and enter a topic such as "how deployment works." The selected provider turns relevant wiki pages into an ordered checklist, explaining why each page comes next and what you will learn from it. Checked steps and generated paths persist across ports and browsers.

A generated learning path — an ordered, tickable checklist of wiki pages

Customize the reader

Choose from 14 palettes in light or dark mode, 11 reading fonts, and an exact font size. Settings are stored in ~/.config/btw-wiki/notebook.json or under $XDG_CONFIG_HOME when it is set, so they follow you across projects and browsers.

The palette menu showing the built-in themes

Keyboard shortcuts

Shortcut Action
g Return to Contents.
a Open Ask.
v Open the graph view.
b Show or hide the sidebar.
t Toggle light and dark mode.
k / j Go back / forward through visited pages.
⌘K or / Open the search palette.
? Show the shortcut help.
Esc Close a menu, or clear the search filter.

Back to README