Skip to content

babylon-runtime/babylon-runtime.github.io

Repository files navigation

Babylon Runtime Documentation

Available on babylon-runtime.github.io

Contribute

  1. Clone repository
git clone https://github.com/babylon-runtime/babylon-runtime.github.io.git
  1. Install Ruby with devkit

  2. Install Bundler

gem install bundler
  1. Install Jekyll and other dependencies
bundle install
  1. Serve the site
npm run serve

and visit it at http://127.0.0.1:4000

  1. Pull request

Conventions

  • images should be saved in /assets/ folder, well named and classified
  • image or code caption should be placed below these elements, in italic, starting with a capital letter, ending with punctuation. example:
![logo](logo.png)
*This is a beautiful logo.*
  • _r should be write in markdown as \_r (\ char is here to avoid conflict with markdown syntax)
  • _runtime should be write also with the \_ char as prefix
  • codeblocks should have langage name specified. example: ```js