Skip to content

Latest commit

 

History

History
36 lines (20 loc) · 1.53 KB

README.md

File metadata and controls

36 lines (20 loc) · 1.53 KB
Raw

How to contribute

Running the site locally

  1. Clone the repo.

  2. Run bundle exec jekyll serve from the root directory.

  3. Browse localhost:4000.

Automated deployment

Upon each change in the repo, a GitHub Pages job is initiated, taking care of building and deploying the site.

Posting news

News are stored in the /_posts with every post in its own .md file. The name of the file is shown in the URL. The header section contains metadata used by the website to render the news. In particular, the following elements have to be changed whenever a post is made:

  • title
  • date - we use the GMT-5 offset
  • categories - free text, no specific rules for now

In the body, you can use <!--more--> to separate the excerpt (shown in the newsfeed) from the rest of the text.

Adding data

Data is stored in the /_data folder in yml and csv files. Jekyll pages can use data as site.data.[subfolders]*.[filename]. This example shows a simple counting of the active members on the landing page: https://raw.githubusercontent.com/geodes-sms/geodes-sms.github.io/main/index.md.

Adding images

Data is stored in the /images folder. Jekyll pages can use images via simple hyperlinking.

Helpful resources