Skip to content

😷 Informative website about the corona virus 🦠

License

Notifications You must be signed in to change notification settings

covprehension/CoVprehension

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

Logo CoVprehension

Informative website about the corona virus.

License Β· GitHub issues Β· GitHub contributors
Jekyll site CI Β· Discord

This repository holds the Jekyll sources of the CoVprehension website!

CoVprehension is a collective of researchers trying to explain the current epidemic of COVID-19 simply yet with scientific tools.

You can publicly see tracking data here : https://covprehension.goatcounter.com/

How to contribute to the project

I'm a writer / translator

Please go to the _i18n/ sub-folder where everything's is explained ;)

> Click me <

I'm a dev

I want to work on this website

Read the contributing guidelines πŸ‘©β€πŸ’»

I want to work on a NetLogo simulation

Go on this other repository covprehension/proto

Technical part

Structure of the repository

View contents
$ tree
.
β”œβ”€β”€ assets/
β”‚Β Β  β”œβ”€β”€ lang/
β”‚Β Β  |   β”œβ”€β”€ <translation files for JS simulations>
β”‚Β Β  β”‚Β Β  └── simu-XX.js -> ../../_i18n/fr/simu-XX.js
β”‚Β Β  β”œβ”€β”€ vendor/ <default resources>
β”‚Β Β  └── <custom JS/CSS files>
|
β”œβ”€β”€ _i18n/ <== Folder where website is translated
β”‚Β Β  β”œβ”€β”€ <anyLanguageCode>/
β”‚Β Β  β”‚Β Β  β”œβ”€β”€ pages/
β”‚Β Β  β”‚Β Β  β”‚Β Β  β”œβ”€β”€ about.html
β”‚Β Β  β”‚Β Β  β”‚Β Β  β”œβ”€β”€ resources.md
β”‚Β Β  β”‚Β Β  β”‚Β Β  └── simulator.md
β”‚Β Β  β”‚Β Β  β”œβ”€β”€ _posts/
β”‚Β Β  β”‚Β Β  β”‚Β Β  β”œβ”€β”€ YYYY-MM-DD-qXX.md
β”‚Β Β  β”‚Β Β  β”‚Β Β  └── <All your questions>
β”‚Β Β  β”‚Β Β  └── simu-<anyLanguageCode>.js
β”‚Β Β  └── <anyLanguageCode>.yml
|
β”œβ”€β”€ img/
β”‚Β Β  β”œβ”€β”€ about/
β”‚Β Β  β”œβ”€β”€ post/
β”‚Β Β  └── <website images>
β”‚
β”œβ”€β”€ _includes/
β”‚Β Β  └── <Global part of website : Header/Footer/etc>
β”‚
β”œβ”€β”€ _layouts/
β”‚Β Β  └── <HTML pages template>
β”‚
β”œβ”€β”€ posts/
β”‚Β Β  └── <IGNORE ME, I'm a trap πŸ™Š>
β”‚
β”œβ”€β”€ _pages/
β”‚Β Β  └── <Defined layout for translated pages>
β”‚
β”œβ”€β”€ simulations/
β”‚Β Β  β”œβ”€β”€ js/
β”‚Β Β  β”‚Β Β  └── <JS simulation in sub-dir>
β”‚Β Β  └── <Web NetLogo export simulations>
β”‚
β”œβ”€β”€ _config.yml
β”‚
└── <others uninteresting stuff...>

<plenty> directories, <too many> files

Local installation & Setup

First of all, make sure ruby is intalled on your computer.

  1. Clone the repo git clone https://github.com/covprehension/CoVprehension.git
  2. Move in the folder cd CoVprehension
  3. Install plugins: bundle install
  4. Replace the symlink JS translation files by the real ones rm -f assets/lang/*.js && cp _i18n/*/simu-*.js assets/lang/
  5. Build your site: bundle exec jekyll serve
  6. Connect to your running instance http://127.0.0.1:4000/CoVprehension/

Global configuration of the website

All the global configuration of the site can be found in the file _config.yml which is structured as follow :

View contents
  • General settings
    • title Global title
    • email Global mail
    • description
    • url
    • baseurl root position of the website in the url variable
      • Don't change me
    • include Jekyll collection list
  • Social Profiles (all optionals)
    • twitter_username
    • github_username
    • facebook_username
    • linkedin_username
    • rss_link
    • google_analytics
  • Build settings
    • markdown MarkDown compiler
    • paginate
    • paginate_path how to generate pagination url
    • plugins list of ruby plugins used in the website
  • Multi language website => See https://github.com/kurtsson/jekyll-multiple-languages-plugin/#4-configuration
    • languages list of enabled languages
    • exclude_from_localizations

Bugs and Issues

Have a bug or an issue with this template? Open a new issue here on GitHub!

Made with

Copyright and License

The code of this project is licensed under the LGPL-3.0 License.

The text content in posts is licensed under the CC BY-SA 4.0.

These illustrations in posts are licensed under CC BY-NC-ND 4.0.