Documentation

Find what you want to do below, and the page that shows you how. If you are new, start with Getting started: it installs Sheaf and covers the three controls you need on the first day. Settings is the reference for every setting and command.

Write a document

• Typing Markdown: type the markers you already know, and use Enter, Shift+Enter and Tab the way Markdown expects.
• The toolbar: set text style, make lists, quotes and code blocks, insert blocks, and undo.
• Formatting: make text bold, italic, highlighted or code, and write code blocks and inline HTML.
• Slash menu: insert a block by typing a slash.
• Blocks: move, duplicate, delete and convert whole blocks, with the grip or the keyboard.
• Menus: use the toolbar over a selection and the right-click menu.
• Links: follow a link, or write one by picking a file or a heading.
• Images: paste or drop in pictures, then resize, align or caption them.

Keep a table current

• Tables: read and edit a Markdown table as a grid.
• Table rows and columns: add, delete, move, sort, align and resize rows and columns.
• Selecting and pasting cells: select cells, then copy and paste them, to and from a spreadsheet.
• Moving around a table: move the caret between cells, into a table and out of it, and the keys for every move.
• The Markdown under a table: format text inside a cell, and see the Markdown a cell or a whole table is written in.

Work with data in a document

• Datatables and views: name a CSV block and show it filtered and sorted with a view.
• Working in a view: sort, filter, hide columns and edit cells from a view.
• Boards: show a table’s rows as cards, grouped by one value.
• Data files: open a CSV or TSV file as a grid, and move rows between blocks and files.

Write with an agent

• Files and saving: keep writing while something else edits the file, and see what it changed.
• Sharing a reference: hand the lines you are looking at to an agent.
• In a browser: open a folder’s documents in a browser tab, for apps that cannot load an editor.

Read and find your way

• Table of contents: jump around a long document from a panel of its headings.
• Find and replace: find text anywhere, tables included, and replace it.
• Front matter: show a document’s YAML block in full, as one line, or not at all.
• Comments: read notes left in a document, and collapse or hide them.

Make it read the way GitHub reads it

• Diagrams: Mermaid diagrams drawn in place.
• Maths: equations between dollar signs, typeset in place.
• Footnotes: numbered notes, with the note a hover away.
• Callouts: notes, tips, warnings and cautions.

About these pages

Each page describes behaviour Sheaf is committed to, and every statement is backed by the scenarios that test it, so a page and the product go out of step only if a test is failing.