The Map Academy is an online resource to learn all things digital maps and visualizations. We'll go on publishing courses to tackle different challenges in online mapping, from introductory courses to advanced ones. Its an open project in which anyone can contribute.
The Map Academy website is built on top of Jekyll, a simple content management system for static sites.
In order to install Jekyll make sure you have Ruby and Compass installed.
gem install jekyll
gem install compass
When working on a new feature, we recommend forking and creating a new branch from master
. After commiting your changes open a Pull request to initiate discussion.
We use Compass to organize and work with stylesheets.
To compile the project's sass files into css:
compass compile
To watch the project for changes and compile whenever it does:
compass watch
This would be solved once we migrate to 2.0
(see TODO)
To start the server type the next command in your shell:
jekyll serve -w
And access normally in your browser to the next address:
The site normally has a static page, a layout, a js and a css per section (default, course, lesson). Courses are filled dynamically from the child pages, lessons.
To contribute just check the instructions in CONTRIBUTING.md
Once the Pull Request has been reviewed and the branch passes the tests, it can be merged to the master branch for deployment.
Then, you can type:
jekyll build --config _config-production.yml
With the production configuraion to deploy the static files.
- Migrate to Jekyll 2.0