MagneticEarth / MagneticEarth.github.io

magneticearth.org: A place to learn about geomagnetism

Magnetic Earth website

Check the live deployment of the site at https://magneticearth.org/

Use Gitpod to develop on the website:

Technical details

The site is hosted for free using GitHub Pages and built using Jekyll, which makes the site easy to maintain and version control, and enabling external contributions through pull requests. We use the Hydeout Jekyll theme. Changes to the repository main branch are automatically built and deployed. To test the changes locally is more complicated:

1. Install Jekyll
2. Get the repository and make changes:

git clone https://github.com/MagneticEarth/MagneticEarth.github.io.git
cd MagneticEarth.github.io
...

3. Serve the website locally:

bundle install
bundle exec jekyll serve

4. Browse to http://127.0.0.1:4000/

Tips for working with Jekyll

• Markdown cheat sheet
• Put images in pages/figs/ and insert in-line with e.g. ![Swarm spacecraft](/pages/figs/swarm_sc.png)
• Include html from static files (e.g. html tables) stored in pages/figs/ with {{ "{% include_relative figs/table_models.html " }}%}
• Follow the style guide of The Carpentries