Vorto / Homepage

Overview

The Vorto homepage has been created using Jekyll. Jekyll is a blog aware, static site generator which is licensed under MIT.

Jekyll Installation

For a detailed description how to install jekyll please follow this link.

Getting Started

• Clone the Vorto Repository from GitHub.
• From command line, navigate to the "vorto\docs" directory.
• To build, use any of these approaches:
  • Run "mvn package" from command line or
  • run "jekyll build" or "jekyll b" from command line.
• To run the jekyll website, enter "jekyll server" or "jekyll s" form commandline.
• Open your browser and navigate to the url "http://localhost:4000/".

Folder structure of the Vorto Jekyll module

_layouts

The "_layouts" directory contains all the website layouts for the pages. The "default.html" is used for most of the pages. For layout customizations, a separate new layout can be created (cf. documentation.html) or extended from "default.html" (cf. "news.html).

_includes

The _includes directory contains all static html sections that are included within the main layouts structure. The files "header.html" and "footer.html" are for header and footer sections of any layout.

_data

The "_data" directory contains

• "menus.yml" - The top level configurable menu items.
• "doclinks.yml" - Documentation side navigation links and group structure.

img, css, js

The folders "img" , "css" and "js" contain all static images, css, and Javascript resources respectively.

Markdown

The image files can be referenced within markdown as follows: ![Alternate Text] /img/<<filename>>.

Hosting

The static website is generated in the "_site" directory. All files contained in this directory need to be copied into the destination folder of the hosting website domain.

Contributing

The news page

To add a "news" content, the filename should follow the convention <<yyyy-mm-dd-filename>>.md within the vorto\docs\news directory. The Markdown file should contain the additional meta information on the top section. (see 2015-03-08-iotasia.md as an example).

The blog page

To add a "blog" content, the filename should follow the convention <<yyyy-mm-dd-filename>>.md within the vorto\docs\blog\_posts directory. The Markdown file should contain the additional meta information on the top section. (see 2014-10-07-eclipseiot.md for example).

The documentation page

The Vorto documentation is organized in a tree like navigation structure. All the documentation (markdown contents) are grouped within vorto\docs\documentation\ and in corresponding sub folders. All the left side tree navigation links are specified within the file vorto\docs\_data\doclinks.yml. For creating a new top level section, add the following entry in doclinks.yml:

- title: "Parent Link"
  href: "<<Relative URL Reference>>"

For creating a child/nested child section add the following entry in doclinks.yml:

- title: "Parent Link"
  href: "<<Relative URL Reference>>"
  sub:
    - title: "First Child"
      href: "<<Relative URL Reference>>"
      sub:
          - title: "Second Nested Child"
            href: "<<Relative URL Reference"

To add new content to the documentation, create a .md file and save it in the "vorto\docs\documentation\" directory. Subfolders can be created in the "documentation" folder for organizing and grouping.

The new markdown file should have the following metadata added by default.

---
layout: documentation
title: <<Title of the Documentation section>>
---
{% include base.html %}