gitbuilding.gitlab.io - GitBuilding

Description: GitBuilding is an open source program for writing hardware build instructions using Markdown. 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*

Example domain paragraphs

GitBuilding Install Usage Running GitBuidling Getting Started Syntax Reference Complex projects Part Libraries Configuring the output About GitBuilding is an open source program for writing hardware build instructions. See an example webpage generated with GitBuilding .

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*.

GitBuilding uses Markdown with some additional syntax . We call this BuildUp. Despite introducing a new format you never risk lock-in. GitBuilding is both open source, and it can export your documentation to plain Markdown. If you wish to move your documentation away from GitBuilding you can export it as plain Markdown.

Links to gitbuilding.gitlab.io (2)