- HTML 59.9%
- JavaScript 37%
- SCSS 1.6%
- CSS 1%
- Ruby 0.5%
| .github | ||
| _i18n | ||
| _includes | ||
| _layouts | ||
| _pages | ||
| _plugins | ||
| _sass | ||
| assets | ||
| img | ||
| posts | ||
| simulations | ||
| .gitignore | ||
| _config.yml | ||
| CNAME | ||
| contact.html | ||
| CONTRIBUTING.md | ||
| Gemfile | ||
| index.html | ||
| LICENSE | ||
| README.md | ||
Informative website about the corona virus.
·
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 ;)
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.
- Clone the repo
git clone https://github.com/covprehension/CoVprehension.git - Move in the folder
cd CoVprehension - Install plugins:
bundle install - Replace the symlink JS translation files by the real ones
rm -f assets/lang/*.js && cp _i18n/*/simu-*.js assets/lang/ - Build your site:
bundle exec jekyll serve - 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
titleGlobal titleemailGlobal maildescriptionurlbaseurlroot position of the website in the url variable- Don't change me
includeJekyll collection list
- Social Profiles (all optionals)
twitter_usernamegithub_usernamefacebook_usernamelinkedin_usernamerss_linkgoogle_analytics
- Build settings
markdownMarkDown compilerpaginatepaginate_pathhow to generate pagination urlpluginslist of ruby plugins used in the website
- Multi language website => See https://github.com/kurtsson/jekyll-multiple-languages-plugin/#4-configuration
languageslist of enabled languagesexclude_from_localizations
Bugs and Issues
Have a bug or an issue with this template? Open a new issue here on GitHub!
Made with
-
Pipeline
- Jekyll
- GitHub Actions
- GitHub Pages
-
Front-end
- Bootstrap / jQuery
- Theme from Start Bootstrap
- Bootstrap / jQuery
-
Simulations
- JS
- NetLogo
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 
.
These illustrations in posts are licensed under 
.