About the GitBuilding category

GitBuilding is an open source program for writing hardware build instructions.

GitBuilding allows you to:

  • Write build instructions as you build, in Markdown, using a two-paned editor that previews the final output.
  • Tag links in your text with meta-data (part specs, descriptions, quantities); marking them as pre-requisite build steps or parts you need to purchase.
  • You can also efficiently bulk-define part meta-data using seperate part libraries in YAML or spreadsheet formats.

GitBuilding uses your tags and meta-data to automatically generate and insert bills of materials into your documentation. It correctly links different steps to one another (even when you have mutliple variants), shows previews of 3D files and lets you easily include links to generated zips and other files in the correct places. Finally, you can output the entire documentation in pure Markdown, HTML or PDF*.


Useful links:

GitBuildng is licensed under the GNU General Public License v3.0