Style Guide


Defined here is the style guide for Half-Built Robots. Blog posts and pages should (mostly) conform to this style. However, as the blog is a living document, I expect the style to drift. Older posts may not receive timely updates.

General Formatting Rules

  1. Every post / page should have the top heading spacer-separator.
  2. Posts / pages should have consistent header hierarchy.

Images

Basic images should be centered as shown. We will not use the caption feature but instead use a centered paragraph below in italics.

Don’t add a caption like this

Add a caption as a centered paragraph here in italics.

For more interesting text heavy captions we format as follows.

Caption should go here in italics.

Or

Flip the caption and media.

Finally, if we need to display multiple images we will use an image gallery like the one below.

Tables

WordPress (and our theme) doesn’t have the best table formatting. If using a native table it should be formatted something like this.

HeaderHeaderHeader
IndexContentContent

Caption for table is optional but generally useful. Also in italics and centered.

For more specialized tables, they will be pre-rendered as an image.

Code Snippets

This is a technical blog and as such will need to occasionally display code as show below.

This is a snippet of code

I caution the use of too many or too long of a code snippet for readability sake.

Mobile readers may also find it hard to read the code while on their phone. It is recommended to redirect to my Github.