Skip to content

nair0lf32/MedicalCheatSheets

Repository files navigation

MedicalCheatSheets

A simple static jekyll blog about medical pathologies, with short posts or articles.

The blog is written in French and articles are added gradually.

The blog includes a progressive web app (pwa) functionality for offline reading (working on it):

  • Data is precached in the browser using workbox.

  • Updating to get latest articles can be done when network is available (online)

  • The app can be installed via the browser prompt.

  • if any problem is faced when installing or updating just clean your browser cache and retry

Any contribution will be possible when license is added.

Usage

git clone the repository, then install the dependencies with bundle install

also every time there is changes in the dependencies you need to install them

then, run the server with bundle exec jekyll serve

The server will make the project available at: http://127.0.0.1:4000/MedicalCheatSheets/

Important note: As this is not a regular jekyll setup but using github-pagesplugin instead, you might have conflicts issues with your ruby version and the plugin versions (gh-pages doesnt support ruby > 2.7) which results in a nightmare especially when you are trying to setup on linux. Here is a temporary (I wish) workaround:

  • Use a ruby version manager (I chose rbenv)
  • Switch to ruby 2.7.0 for this project
  • If you used rbenv too make sure you have the latest version or at least latest version of ruby-build (to avoid an openssl version conflict too *sigh)