jevinskie / sh-wg

SH-wg device website

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

SH-wg documentation repository

This is the SH-wg (Sailor Hat WiFi Gateway) Jekyll documentation repository that is rendered to project documentation available at https://docs.hatlabs.fi/sh-wg/. SH-wg is a NMEA 2000 to WiFi gateway that supports multiple protocols and bidirectional communication.

It is available for purchase at https://hatlabs.fi.

Contributing

You can contribute to the documentation by cloning the repository, modifying the Markdown pages, and creating a Pull Request. Instructions for generic GitHub use can be found at The GitHub Guides.

The pages are rendered using Jekyll which is the standard tool for rendering GitHub pages. The Jekyll theme in use is Just the Docs. The site uses kramdown as its Markdown flavor.

If you want to test your modifications locally, your easiest option is to run first ./docker-jekyll bundle (one time only) and then ./docker-jekyll bundle exec jekyll serve in the cloned directory and then browse to 0.0.0.0:4000/sh-wg. You must have Docker pre-installed.

About

SH-wg device website

License:Other


Languages

Language:Ruby 56.9%Language:HTML 26.2%Language:Shell 13.6%Language:SCSS 3.4%