Skip to content

serval-snt/serval-snt.github.io

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

56 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Serval website using Jekyll 💊

🧐 How it works

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.

💻 Testing Locally

Before pushing your changes to GitHub, you might want to test the site locally.

⚙️ Prerequisites

  1. 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
  2. Install Jekyll and bundler gems:

gem install jekyll bundler
  1. In this repository, run:
bundle install

🏃 Run it

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 page

  1. Create a new .html or a new .md file in the _pages directory.
  2. At the top of the file, add the following front matter:
---
layout: default
title: Your Page Title
---
  1. 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:
    ![Serval](/assets/serval.jpg)

    HTML example:

    <h1>Your Page Title</h1>
    
    <p>This is a <b>new page.</b></p>
    
    <img src="/assets/serval.jpg" alt="Serval">
  2. Save the file, test it, push it, and enjoy your new page! 🎉

About

Github pages for Serval

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 5