This repository contains the source for the LibrePCB documentation hosted at docs.librepcb.org.
- HTML output of
master: https://docs.librepcb.org - PDF output of
master: librepcb-user-manual-nightly.pdf - HTML output of other branches: https://docs.librepcb.org/_branches/
- PDF output of other branches: https://download.librepcb.org/nightly_builds/
The documentation is written in Asciidoc and built with Asciidoctor.
On Linux the required tools can be installed with following commands:
gem install asciidoctor pygments.rb rouge
gem install asciidoctor-pdf --pre
On Mac you can use homebrew and install gems in your user folder:
brew install asciidoctor
gem install --user-install pygments.rb rouge
This will keep your installation more resilient to OS X upgrades.
asciidoctor index.adoc # build index.html
asciidoctor-pdf index.adoc # build index.pdf
Contributions are very welcome! See our Contributing Guide for details. We're looking forward for pull requests :)
- AsciiDoc Syntax Quick Reference
- Asciidoc Writer's Guide
- Asciidoctor User Manual
- AsciidocFX (Asciidoc editor with live preview)
This documentation is published under the CC0 1.0 Universal license.