This repository contains the code of the spine.io site. It is based on Jekyll and is hosted on GitHub Pages.
This project is two-headed:
- It is a Ruby project because of Jekyll.
- It is a Gradle project to for checking the source code embedded to the site.
The code samples used on the site and in the framework documentation are added using
the embed-code
Jekyll subcommand.
The code resides under the _code
directory. For instructions on embedding the code into the pages,
please see the _code/EMBEDDING.md
file.
- Install Ruby.
- Install the
bundler
tool. - Install the project dependencies by running
bundle install
.
Now you should be able to run the site locally.
To build and launch the site on the local server:
./gradlew :runSite
To build the site without running the server:
./gradlew :buildSite
If you experience issues with this step, please check out the Troubleshooting Guide.
For instructions on adding the content to the site, please see
the AUTHORING.md
file.