Giter Club home page Giter Club logo

balena-fin's Introduction

balenaFin repository

Official documentation repository for the balenaFin board.
Get it now from the official balenaFin store.

Directory structure

.
├── documentation
│   ├── CAD                          # 3D files for balenaFin and accesories
│   ├── PDF                          # PDF files generated from markdown source using the builder
│   └── markdown                     # balenaFin and accesories documentation source files
└── software                         # Linux config files for accessing balenaFin HW
├── builder.css                      # PDF generator files
├── config.json                      # PDF generator files
├── index.js                         # PDF generator files
└── package.json                     # PDF generator files

Generated documentation

All files inside documentation/CAD and documentation/PDF are official balenaFin documentation. They are automatically generated from markdown files in documentation/markdown.

Building PDF releases

All PDF documentation is generated automatically frorm markdown files. To install the PDF generator, clone the repository and run npm install

config.json allows to define the document sources and their destination folder, along with custom overall styling

Once config.json is configured, run npm start to generate the PDF

Project specific syntax

Page breaks

Creating a pagebreak on the destination PDF. It's important to leave a blank line above and below.

<div class="page-break"></div>

balena-fin's People

Contributors

curcuz avatar balena-ci avatar ntzovanis avatar bucknalla avatar chrisys avatar nazrhom avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.