This is the website for the Global Name Service (GNS). It is based on version 5 of the Jekyll Documentation Theme (Github). It is modified to suit the needs of this project and removes unneeded functionality.
- Install dependencies
- gem (Ruby Gems)
- nodejs and npm
- bundler
- Clone the repository
- Run
bundler installfrom the cli in the root directory of the project - (Optional) Run
bundler updateto check for updated gems - Run
bundler exec jekyll serveto start the local web server - View your local site at http://localhost:4000/
As you save modified files Jekyll will continue to rebuild the site, allowing you to refresh the webpage to see them. Note changes to _config.yml require a restart of the webserver.
See CONTRIBUTE.md for details regarding how to edit and add content to the site. This document and existing content should give you a good idea of what to do.
Jekyll was chosen so that a contributer only need to know Markdown (or have a reference handy) to make content. Content is separated from styling which allows contributers to easily create and update content without worrying about proper. If you wish to change more than the just the content of the site you should be familiar with Jekyll.