Skip to content
This repository has been archived by the owner on Oct 17, 2022. It is now read-only.

Latest commit

 

History

History
47 lines (30 loc) · 1.78 KB

README.md

File metadata and controls

47 lines (30 loc) · 1.78 KB
Raw

Read the documentation online

Go here

This is the source code of the documentation. If you're looking to read it, go to Github pages

Contibute to documentation

Prerequisites

You're going to need:

  • Linux or macOS — Windows may work, but is unsupported.
  • Ruby, version 2.3.1 or newer
  • Bundler — If Ruby is already installed, but the bundle command doesn't work, just run gem install bundler in a terminal.

Getting Set Up

  1. Fork this repository on GitHub.
  2. Clone your forked repository (not our original one) to your hard drive with git clone https://github.com/blockchangers/brreg-docs.git
  3. cd brreg-docs
  4. Initialize and start the documentation framework Slate. You can either do this locally, or with Vagrant:
# either run this to run locally
bundle install
bundle exec middleman server

# OR run this to run with vagrant
vagrant up

# Docker
docker-compose up -d

You can now see the docs at http://localhost:4567. Whoa! That was fast!

Now that Slate is all set up on your machine, you'll probably want to learn more about editing Slate markdown.

If you'd prefer to use Docker, instructions are available in the wiki.

Please create a pull request to have your edits be imported into the documentation.

Note on JavaScript Runtime

For those who don't have JavaScript runtime or are experiencing JavaScript runtime issues with ExecJS, it is recommended to add the rubyracer gem to your gemfile and run bundle again.