Basics

Writing with JustDocs

Every block the editor offers, each with a live example and when to use it.

A JustDocs page is a column of blocks: paragraphs, headings, callouts, code, tables, diagrams and more. In the editor, type / on an empty line to pick one, or drag a block by its handle to move it.

This site shows each block as readers see it, with a few words on when it helps and when something else would do better. Open it in the editor to see the same pages from the writer's side.

Three habits of easy pages

  1. One idea per page. Readers arrive from search with one question. Answer it near the top.
  2. Short paragraphs. Two or three sentences each, then a heading, a list or an example.
  3. The right block for the job. A sequence is steps, a choice is tabs, a warning is a callout. Each page in this site says when to use which.

Tip

Every page has Copy page and View as Markdown at the top. They show the Markdown behind the blocks, the same format JustDocs imports and exports.