Skip to content

Latest commit

 

History

History
59 lines (36 loc) · 4 KB

README.md

File metadata and controls

59 lines (36 loc) · 4 KB

Hi!

This is the repo for developing the Build FOSH following demand website.

This repository is setup as a Github.io page. It is the place for people to read all the information about the project and find ways to contribute, participate on the survey and advertise the project to others.

We try to be as open as possible, so everything is released under GPL v3.0.

Also to make sure all contributors and visitors have a good time while interacting with the project and with one another, we have a code of conduct, please make sure to take a look at it!

Developer information

  • Multilingual support is outlined in this article

  • Bootstrap navbar links are automatically generated from the language translation collection in _config.yml

  • Infinite Scroll is used to lazy-load successive pages while scrolling. The navbar links will first load all the pages (in the same order that they appear in _config.yml) until it reaches the clicked link and then animate the scroll position to that section.

  • Custom theme is based on Landing Page Jekyll theme updated to Bootstrap v4.0 and jQuery v3.3.1

  • jekyll-compress-html layout is to compress HTML without a plugin.

  • Because we want to use plugins that are not supported by github.io, we need to generate the pages of the website locally, and then push them to github. This is a bit counter-intuitive when considering how github.io pages is setup, but it allows to use many plugins, taking full advantage of Jekyll features. a nice explanation on how to do this is here


## Useful documentation links:

Contributors:

None of this would be possible without the contributions of many wonderful people.

Below are contributors that have made comments, requests, solved issues, and interacted directly here on GitHub:

EmDupre Gooshie Johav Thessaly Vektorius Gusma MaxZimmer
pgpadilla chpmnrssll aquillesC torlax patito jurra

Our appreciation note also to the ones that are not on this platform, but contributed anyway!