Skip to content

Markdown Style Guide

Editing the developer documentation should have a low barrier of entry. For that reason, guidelines are kept minimal.

  • Two space indentation
  • Lines should be less than 100 characters long (1)
  • Use italics for UI terms (buttons, labels, etc.)
  • Use <br/> to enforce line breaks as opposed to two trailing spaces
  1. The limit of 100 was chosen because 80 generally ends up in extensive wrapping, whereas 120 makes editing side by side difficult (e.g. markdown editor side by side with a browser showing the rendered output).

Editor Configuration

Some editors/IDEs will use the .editorconfig from this repository for basic formating options. For other editors, there are plugins available to enable this.