Style Guide

From The Brainwrecked Wiki
Jump to navigation Jump to search

Not much in the way of formality here. There are a few things that I ask.

Use <tt>...</tt> when referencing in mid-sentence:

  • command names or lines as they would be typed into a terminal.
  • sections or parameters as they appears in a config file.
  • file names

Use preformatted text when:

  • a command line is a little long and would be hard to read inline in a sentence.
  • referencing multiple lines of commands, output, or config files.