GitBuilding uses a markdown-like syntax called BuildUp. We plan to formalise BuildUp into a standard once we have figured out what works best.

Detailed explanations of syntax

For more details please see

Basic example:


# Making a widget

## You will need
{{BOM}}

## Method
Take two [M6x10 cap screws](m6capscrew.md){Qty: 2} and screw them into the bottom of the [widget base](base.md){Qty:1} using a [5mm ball driver]{Qty: 1}.

[5mm ball driver]: balldriver.md "{cat: Tool}"

Screw two more [M6x10 cap screws]{Qty: 2} into the top of the [widget base] the [same ball driver][5mm ball driver]{Qty: 1}.


Will evaluate to

Making a widget

You will need

Parts

Tools

Method

Take two M6x10 cap screws and screw them into the bottom of the widget base using a 5mm ball driver.

Screw two more M6x10 cap screws into the top of the widget base the same ball driver.

A full example is available.