Sienna Website

This repo builds the main Sienna website. Refer to this repository and readme if you are making edits to the public website and need to view your draft edits; otherwise please refer to the website itself.

It is a website built in 2 parts:

1. Main landing pages, built using Jekyll in Ruby.
2. Technical documentation pages written and compiled by Documenter.jl, which are then linked from the main website. These files are located in the SiennaDocs/ subfolder.

Serving the main website with Jekyll

Install Ruby and Jekyll according to the Jekyll installation guide.

Serve the website from the root of the repository:

bundle exec jekyll serve --livereload

The website can be then viewed in a browser by navigating to:

localhost:4000/Sienna/

Updating the SiennaDocs technical documentation

If you are making changes to the technical documentation pages in SiennaDocs, compile the markdown into .html files by running from the SiennaDocs subfolder:

julia --project=docs docs/make.jl 

This step is necessary to make any changes to SiennaDocs visible when serving the website using Jekyll. The updated technical documentation will also be viewable on its own by opening the SiennaDocs\docs\build\index.html file (double-click to open in a browser).

For more information, see How to Compile and View Documentation Locally in Sienna's InfrastructureSystems.jl package.