This is the official GeoKey project website.
The website is hosted in GitHub Pages — any commit that is pushed to the branch gh-pages is immediately reflected on the live website.
It is recommended to run the site on your machine when you plan to add to the site.
Follow these steps to install an run the site locally:
Install the following packages:
In the directory geokey-website:
- Run
bower installto install Bootstrap (Sass distribution) - Run
npm installto install the build requirements
In the directory geokey-website:
- Run
gruntto build the CSS and optimise images
In the directory geokey-website:
- Serve the site using
jekyll serve- the site should be accessible underhttp://localhost:4000/
When running the commend, Jekyll collects all static files, blog posts and collections and coverts markdown into HTML. The finished build of the site can the be found in the directory _site.
The directory structure of this site follows the standard Jekyll site structure.
_config.yml is the config file Jekyll uses to build the site (see docs).
All templates that Jekyll uses to convert markdown into HTML live in _layouts.
Each markdown file has a front matter that defines, which template to use when converting.
Templates themselves can have a front matter — in that case the content of the current template is nested into the template defined in the front matter.
Some content is used in different places across the site. These includes live in _includes.
All blog posts can be found in _posts (see Writing posts in the Jekyll docs).
All documents in these directories are Markdown files.
Documentation as well as help and extension sites are grouped into collections:
_docscontains documentation of the web API and the programming API,/docs/on the site_extensionscontains all extension pages,/extensions/on the site_helpcontains the help section,/help/on the site
All documents in these directories are Markdown files.
Other directories and files are static files. When the site is build, they a simply copied into the _site directory.