https://github.com/windingtree/developer-portal
Contains the documentation for the Winding Tree Developer Portal using Jekyll and Markdown
https://github.com/windingtree/developer-portal
documentation travel
Last synced: 6 months ago
JSON representation
Contains the documentation for the Winding Tree Developer Portal using Jekyll and Markdown
- Host: GitHub
- URL: https://github.com/windingtree/developer-portal
- Owner: windingtree
- Created: 2020-08-09T08:08:03.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2022-07-04T13:21:48.000Z (almost 4 years ago)
- Last Synced: 2025-01-24T06:42:39.048Z (over 1 year ago)
- Topics: documentation, travel
- Language: SCSS
- Homepage: https://developers.windingtree.com
- Size: 1 MB
- Stars: 3
- Watchers: 5
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Developer Portal
## Purpose
This repository allows to build the developer portal hosted at: [https://developers.windingtree.com](https://developers.windingtree.com).
## Dependencies
* [Ruby](https://www.ruby-lang.org/)
* [Jekyll](https://jekyllrb.com/)
* [Bundler](https://rubygems.org/gems/bundler)
```shell
gem install jekyll bundler
```
## Local Development
Clone the repository
```shell
git clone https://github.com/windingtree/developer-portal.git
```
Change to the repository's directory:
```shell
cd developer-portal
```
Install the gem dependencies:
```shell
bundle install
```
Build and launch the server
```shell
bundle exec jekyll serve
```
Browse to [http://localhost:4000](http://localhost:4000)
When you are ready to publish, you can build the static site which will be made available in the `_site` directory:
```shell
bundle exec jekyll build
```
## Creating Diagrams
[PlantUML](https://plantuml.com/) diagrams can be added thanks to the [jekyll-remote-plantuml](https://github.com/Patouche/jekyll-remote-plantuml) plugin.
{% uml %}
Bob -> Alice : Hello
{% enduml %}
Auto-generated diagrams need to be manually added in static builds:
```shell
mv assets/images/plantuml _site/assets/images/plantuml
```