The website is built using Jekyll, a very simple, blog-aware, static site generator. It allows us to create website pages using HTML and Markdown, and it's directly supported by GitHub Pages.
Brief overview of the key folders and files:
File/Folder | Description |
---|---|
_pages/ |
Contains pages of the website. - index.html is the main page - example.html will be accessible at serval-snt.github.io/example |
assets/ |
Contains images, CSS, and other static files. |
_layouts/default.html |
The default layout used at every page. Contains the navigation bar, which you can edit. |
_config.yml |
Jekyll website config. |
Gemfile |
Ruby gems needed to run it locally. |
members.py |
Python script to retrieve the list of Serval members. |
Before pushing your changes to GitHub, you might want to test the site locally.
-
Install Ruby:
- Debian/Ubuntu:
sudo apt-get install ruby-full build-essential zlib1g-dev
- Fedora:
sudo dnf install ruby ruby-devel zlib-devel
- macOS:
brew install ruby
- Debian/Ubuntu:
-
Install Jekyll and bundler gems:
gem install jekyll bundler
- In this repository, run:
bundle install
Build the site and make it available on a local server.
bundle exec jekyll serve
Now browse to http://localhost:4000
🚀 Once your changes are ready, push them to GitHub. GitHub Pages will automatically build and deploy the site.
Happy testing! 🧪
- Create a new
.html
or a new.md
file in the_pages
directory. - At the top of the file, add the following front matter:
---
layout: default
title: Your Page Title
---
-
Below the front matter, add your page content in Markdown or HTML.
Markdown example:# Your Page Title This is a **new page**. Here is an image: 
HTML example:
<h1>Your Page Title</h1> <p>This is a <b>new page.</b></p> <img src="/assets/serval.jpg" alt="Serval">
-
Save the file, test it, push it, and enjoy your new page! 🎉