https://github.com/nair0lf32/mcs

A Jekyll blog with medical articles in French
https://github.com/nair0lf32/mcs

articles blog cheatsheets github-pages jekyll medecine medical pathologies

Last synced: 2 months ago
JSON representation

A Jekyll blog with medical articles in French

• Host: GitHub
• URL: https://github.com/nair0lf32/mcs
• Owner: nair0lf32
• Created: 2021-09-09T19:41:48.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2024-09-24T09:45:19.000Z (3 months ago)
• Last Synced: 2024-10-11T13:15:33.687Z (3 months ago)
• Topics: articles, blog, cheatsheets, github-pages, jekyll, medecine, medical, pathologies
• Language: HTML
• Homepage: http://dev.nairolf32.com/mcs/
• Size: 2.99 MB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • Authors: authors.markdown

Awesome Lists containing this project

README

        
# MedicalCheatSheets (MCS)

A simple static [Jekyll](https://jekyllrb.com/) 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 pre-cached in the browser using [workbox](https://developers.google.com/web/tools/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

- Install the dependencies with `bundle install`

- Run the server with `bundle exec Jekyll serve`

- `bundle exec jekyll build` to build the project

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

**Important note**: As this is not a regular Jekyll setup but using `github-pages`plugin instead,

you might have conflicts issues with your ruby version and the plugin versions (gh-pages doesn't 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](https://github.com/rbenv/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)