/smbee

SMBee main documentation

Primary LanguageSCSS

published

SMBee construction documentation source

The site is deployed to: https://milelo.github.io/smbee

Building the documentation locally

You can build this documentation locally to support development.

If you don't already have them, install the necessary tool chain utilities:

OSX

  1. ruby: https://www.ruby-lang.org/en/documentation/installation/
  2. bundler: https://bundler.io/
  3. git: https://git-scm.com/book/en/v2/Getting-Started-Installing-Git

Windows

  1. install chocolatey: https://chocolatey.org/install
  2. install jekyll: https://chocolatey.org/packages/jekyll

Build and serve the site locally:

  1. Clone the repo locally in a suitable location: git clone https://github.com/milelo/smbee.git
  2. Install the gems from the local repo root folder: bundle install
  3. Build and serve the site locally: bundle exec jekyll serve