GitRead Docs

Features

Editor overview

The layout

The editor panel has three columns:

  1. Projects on the far left, to switch between or create projects and to open project settings.
  2. Pages in the middle, showing the page tree with its groups and subpages.
  3. The current page on the right, where you write.

The projects column can be collapsed to a narrow rail to give you more room to write.

Edit and Preview

Above the page there is a switch between Edit and Preview. The preview renders the page exactly as readers will see it, including hints, tables, code blocks and diagrams.

Writing with blocks

Every paragraph, heading, list or table is a block. You work with blocks in three ways:

  • Type / at the start of an empty line to open the block menu. Keep typing to filter, use the arrow keys to move and Enter to insert.
  • Use Markdown shortcuts. Typing # followed by a space turns the line into a heading, - into a list, and so on. See Keyboard shortcuts.
  • Use the controls next to a block. Hover a block to reveal a + button to insert a block and a drag handle to reorder it.

All blocks are described in Blocks reference.

Formatting text

Select text to show the formatting toolbar. It offers bold, italic and strikethrough. You can also:

  • turn the selection into a link with Ctrl + K
  • turn the selection into inline code with Ctrl + E

Autosave

The editor saves automatically about a second and a half after you stop typing. The indicator at the top right shows one of three states:

Indicator Meaning
Saving… Your changes are being sent.
Not saved You have changes that are waiting to be saved.
Saved Everything is stored.

Wait for the Saved indicator before closing the tab if you have just made a large change.

Pasting content

Pasting text into the editor keeps it clean. Plain text is inserted as text, and multi-line text becomes separate lines or blocks. To bring in a whole Markdown document, use the Markdown (Import) block. It converts your Markdown into real blocks such as paragraphs, lists and tables.

Under the hood: Markdown

Pages are stored as Markdown with a few extensions for hints, buttons, link cards and code captions. Anything the editor cannot represent as a block is kept in a Markdown (raw) block, so nothing is lost. See Markdown syntax for the full list.