muruganandham / WhirlyGlobe-Maply-Site

WhirlyGlobe-Maply Documentation Fork

This fork is for the Jekyll conversion of WhirlyGlobe-Maply documentation. Here's how you'd set up to work on the docs.

Ruby Versions and Gemsets

Perform a single-user installation of RVM. Be sure that your installation passes the rvm is a function test.

Git Clone this repository

$ git clone [e-mail]:erictheise/WhirlyGlobe.git
Cloning into 'WhirlyGlobe'...
remote: Counting objects: 111, done.
remote: Total 111 (delta 0), reused 0 (delta 0)
Receiving objects: 100% (111/111), 669.14 KiB | 216.00 KiB/s, done.
Resolving deltas: 100% (33/33), done.
Checking connectivity... done.
$

Use Bundler to install Jekyll and Its Dependencies

$ cd WhirlyGlobe/
ruby-2.1.0 - #gemset created /Users/erictheise/.rvm/gems/ruby-2.1.0@WhirlyGlobe
ruby-2.1.0 - #generating WhirlyGlobe wrappers...........
$ bundle
Fetching gem metadata from https://rubygems.org/.......
Installing RedCloth (4.2.9)
Installing i18n (0.6.11)
Using json (1.8.1)
Installing minitest (5.4.2)
Installing thread_safe (0.3.4)
Installing tzinfo (1.2.2)
Installing activesupport (4.1.6)

...

Installing html-pipeline (1.9.0)
Installing jekyll-mentions (0.1.3)
Installing jekyll-redirect-from (0.6.2)
Installing jekyll-sitemap (0.6.0)
Installing jemoji (0.3.0)
Installing maruku (0.7.0)
Installing rdiscount (2.1.7)
Installing github-pages (28)
Using bundler (1.5.3)
Your bundle is complete!
Use `bundle show [gemname]` to see where a bundled gem is installed.
Post-install message from html-pipeline:
-------------------------------------------------
Thank you for installing html-pipeline!
You must bundle Filter gem dependencies.
See html-pipeline README.md for more details.
https://github.com/jch/html-pipeline#dependencies
$

Run Jekyll to Build Pages and Watch for Edits

$ jekyll serve --baseurl ''
Configuration file: /Users/erictheise/Projects/erictheise/WhirlyGlobe/_config.yml
            Source: /Users/erictheise/Projects/erictheise/WhirlyGlobe
       Destination: /Users/erictheise/Projects/erictheise/WhirlyGlobe/_site
      Generating...
                    done.
 Auto-regeneration: enabled for '/Users/erictheise/Projects/erictheise/WhirlyGlobe'
Configuration file: /Users/erictheise/Projects/erictheise/WhirlyGlobe/_config.yml
    Server address: http://0.0.0.0:4000/
  Server running... press ctrl-c to stop.

This'll start a local server running on port 4000.

Adding/Deleting Pages

The tutorial sidebar yields a linear navigation through the tutorial pages. The ordering is controlled by _data/tutorial.yaml which is simply an ordered list of filenames in the tutorials directory. The "prev/next" arrows also, by default, rely on this ordering, although this may be overridden on a per-page basis.

To manually specify the values for the previous and next pages, you'll add some yaml front matter to the markdown page. Here's an example where the Source Distribution page circumvents the linear progression specified in _data/tutorial.yaml, linking instead to the hello_earth.html and the globe_or_map.html pages.

---
title: Source Distribution
layout: tutorial
prev_next:
  prev: hello_earth.html
  next: globe_or_map.html
---