Docs Ahoy documentation

Writing

On this page
  1. How an edit goes live
  2. In the editor
  3. In this section

Pages are written in Markdown, in the editor of the app. Markdown is also how pages are stored, exported and offered to AI assistants: what you write is what you keep.

How an edit goes live

  1. Open a page and press Edit.
  2. Give your change request a title ("What are you changing?") and press Start editing, or continue a change request you already have open.
  3. Write. Your changes are saved as you type; the bar at the top says when everything is saved.
  4. Preview shows the page as readers will see it.
  5. Review & merge, then Merge and publish, puts every change in the request live at once.

Until the merge, your edits are drafts that readers never see. See Change requests and review.

In the editor

Type / at the start of a line for the list of blocks: hints, steps, images, tables, code, page links and more. Each one inserts the Markdown for you. The blocks and their syntax are on Blocks.

While you write, an Accessibility panel points out images without alt text, headings that skip a level, and link texts that say nothing on their own ("click here"). The notes never stop you from saving or merging.

In this section