Developer Portal

Purpose

This repository allows to build the developer portal hosted at: https://developers.windingtree.com.

Dependencies

• Ruby
• Jekyll
• Bundler

gem install jekyll bundler

Local Development

Clone the repository

git clone https://github.com/windingtree/developer-portal.git

Change to the repository's directory:

cd developer-portal

Install the gem dependencies:

bundle install

Build and launch the server

bundle exec jekyll serve

Browse to http://localhost:4000

When you are ready to publish, you can build the static site which will be made available in the _site directory:

bundle exec jekyll build

Creating Diagrams

PlantUML diagrams can be added thanks to the jekyll-remote-plantuml plugin.

{% uml %} Bob -> Alice : Hello {% enduml %}

Auto-generated diagrams need to be manually added in static builds:

mv assets/images/plantuml _site/assets/images/plantuml