/brewblox-documentation

Technical documentation for the BrewBlox stack

Primary LanguageJavaScriptGNU General Public License v3.0GPL-3.0

BrewBlox Documentation

View the documentation at https://brewblox.netlify.com

This is the code repository for the BrewBlox documentation website. These docs are built with vuepress and written in markdown.

Editing

Recommended tools:

You might want to add these lines to your user Settings:

"markdown.extension.toc.githubCompatibility": true,
"markdown.extension.preview.autoShowPreviewToSide": true,
"markdown.extension.print.absoluteImgPath": false

Building

In the root of this repo, run:

npm install

To build the docs with hot reloading:

npm run dev

The docs will be served at http://localhost:8080