GitRead Docs

Features

Blocks reference

Open the block menu by typing / on an empty line. The menu has three columns.

Text blocks

Block Shortcut Notes
Paragraph none The default block.
Heading 1 # Top-level heading.
Heading 2 ## Section heading. Appears in the page's table of contents.
Heading 3 ### Subsection heading. Appears in the table of contents.
Bulleted list -
Numbered list 1.
Task list [] Checkbox items.

The page title is shown as the main heading, so start your content with Heading 2 for the best table of contents.

Content blocks

Code block

Type three backticks, or choose Code block from the menu. Pick a language to get syntax highlighting. The block menu has two options:

  • With line numbers shows a number gutter.
  • With caption adds a title above the block, for example a file name.

Quote

Type > to start a quote.

Image

Choose Image, then enter the image URL and an alt text that describes the image for screen readers.

Hint

A coloured call-out box in four styles: info, success, warning and danger. Switch the style with the small colour buttons inside the block.

Hints are great for tips, prerequisites and warnings that readers should not miss.

Divider

Type --- to insert a horizontal line.

Table

Choose Table to insert a table. Open the menu of a column or row to:

  • set the alignment of a column (left, center, right)
  • insert a column to the left or right, or a row above or below
  • duplicate or delete a row, or delete a column

Press Tab to move to the next cell and Enter to move down. Enter in the last row adds a new row.

Button

A call-to-action button with a label and a link. Choose between a primary and a secondary style. Several buttons in a row are shown side by side.

A link card. Enter a web address, or search for a page of the same project. Cards for web addresses fetch the title and icon of the target site automatically. Use Update title in the block menu to refresh them.

Advanced blocks

Diagram (Mermaid)

Describe a diagram as text and the editor draws it. Flowcharts, sequence diagrams and more are supported. A sample diagram is inserted so you can adapt it.

Markdown (raw)

An editable Markdown area for content that needs exact control.

Markdown (Import)

Opens a dialog where you paste a Markdown document. It is converted into separate blocks.

Working with blocks

Every block has a menu with these actions:

  • Turn into another block type, for example a paragraph into a heading
  • Move up and Move down
  • Duplicate
  • Delete

You can also reorder blocks with the drag handle that appears next to a block when you hover it.