From d4023b8116a80b36d9935054da97629d7818a7ff Mon Sep 17 00:00:00 2001 From: EDEMESSI Florian Date: Tue, 3 Sep 2024 22:29:08 +0100 Subject: [PATCH] update files --- Gemfile | 2 ++ Gemfile.lock | 42 +++++++++++++++++++++++------------------- README.md | 10 +++++++--- 3 files changed, 32 insertions(+), 22 deletions(-) diff --git a/Gemfile b/Gemfile index 83add2b..1fc7ba8 100644 --- a/Gemfile +++ b/Gemfile @@ -19,6 +19,7 @@ gem 'pygments.rb' # If you want to use GitHub Pages, remove the "gem "jekyll"" above and # uncomment the line below. To upgrade, run `bundle update github-pages`. # gem "github-pages", group: :jekyll_plugins + # If you have any plugins, put them here! group :jekyll_plugins do gem "jekyll-feed", "~> 0.12" @@ -35,3 +36,4 @@ end # Performance-booster for watching directories on Windows gem "wdm", "~> 0.1.1", :platforms => [:mingw, :x64_mingw, :mswin] gem "webrick", "~> 1.7" + diff --git a/Gemfile.lock b/Gemfile.lock index a76051d..92bc808 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -15,7 +15,8 @@ GEM coffee-script-source (1.12.2) colorator (1.1.0) commonmarker (0.23.10) - concurrent-ruby (1.3.3) + concurrent-ruby (1.3.4) + csv (3.3.0) dnsruby (1.72.2) simpleidn (~> 0.2.1) em-websocket (0.5.3) @@ -26,20 +27,20 @@ GEM eventmachine (1.2.7) eventmachine (1.2.7-x64-mingw32) execjs (2.9.1) - faraday (2.10.0) - faraday-net_http (>= 2.0, < 3.2) + faraday (2.11.0) + faraday-net_http (>= 2.0, < 3.4) logger - faraday-net_http (3.1.0) + faraday-net_http (3.3.0) net-http ffi (1.17.0) forwardable-extended (2.6.0) gemoji (4.1.0) - github-pages (231) + github-pages (232) github-pages-health-check (= 1.18.2) - jekyll (= 3.9.5) + jekyll (= 3.10.0) jekyll-avatar (= 0.8.0) jekyll-coffeescript (= 1.2.2) - jekyll-commonmark-ghpages (= 0.4.0) + jekyll-commonmark-ghpages (= 0.5.1) jekyll-default-layout (= 0.1.5) jekyll-feed (= 0.17.0) jekyll-gist (= 1.5.0) @@ -76,9 +77,10 @@ GEM liquid (= 4.0.4) mercenary (~> 0.3) minima (= 2.5.1) - nokogiri (>= 1.13.6, < 2.0) + nokogiri (>= 1.16.2, < 2.0) rouge (= 3.30.0) terminal-table (~> 1.4) + webrick (~> 1.8) github-pages-health-check (1.18.2) addressable (~> 2.3) dnsruby (~> 1.60) @@ -91,9 +93,10 @@ GEM http_parser.rb (0.8.0) i18n (1.14.5) concurrent-ruby (~> 1.0) - jekyll (3.9.5) + jekyll (3.10.0) addressable (~> 2.4) colorator (~> 1.0) + csv (~> 3.0) em-websocket (~> 0.5) i18n (>= 0.7, < 2) jekyll-sass-converter (~> 1.0) @@ -104,6 +107,7 @@ GEM pathutil (~> 0.9) rouge (>= 1.7, < 4) safe_yaml (~> 1.0) + webrick (>= 1.0) jekyll-avatar (0.8.0) jekyll (>= 3.0, < 5.0) jekyll-coffeescript (1.2.2) @@ -111,9 +115,9 @@ GEM coffee-script-source (~> 1.12) jekyll-commonmark (1.4.0) commonmarker (~> 0.22) - jekyll-commonmark-ghpages (0.4.0) - commonmarker (~> 0.23.7) - jekyll (~> 3.9.0) + jekyll-commonmark-ghpages (0.5.1) + commonmarker (>= 0.23.7, < 1.1.0) + jekyll (>= 3.9, < 4.0) jekyll-commonmark (~> 1.4.0) rouge (>= 2.0, < 5.0) jekyll-default-layout (0.1.5) @@ -208,17 +212,17 @@ GEM listen (3.9.0) rb-fsevent (~> 0.10, >= 0.10.3) rb-inotify (~> 0.9, >= 0.9.10) - logger (1.6.0) + logger (1.6.1) mercenary (0.3.6) mini_portile2 (2.8.7) minima (2.5.1) jekyll (>= 3.5, < 5.0) jekyll-feed (~> 0.9) jekyll-seo-tag (~> 2.1) - minitest (5.24.1) + minitest (5.25.1) net-http (0.4.1) uri - nokogiri (1.16.6) + nokogiri (1.16.7) mini_portile2 (~> 2.8.2) racc (~> 1.4) octokit (4.25.1) @@ -228,11 +232,11 @@ GEM forwardable-extended (~> 2.6) public_suffix (5.1.1) pygments.rb (3.0.0) - racc (1.8.0) + racc (1.8.1) rb-fsevent (0.11.2) rb-inotify (0.11.1) ffi (~> 1.0) - rexml (3.3.1) + rexml (3.3.6) strscan rouge (3.30.0) rubyzip (2.3.2) @@ -257,10 +261,10 @@ GEM tzinfo-data (1.2024.1) tzinfo (>= 1.0.0) unicode-display_width (1.8.0) - uri (0.13.0) + uri (0.13.1) wdm (0.1.1) webrick (1.8.1) - zeitwerk (2.6.16) + zeitwerk (2.6.18) PLATFORMS x64-mingw32 diff --git a/README.md b/README.md index 9261afa..b3a313d 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # MedicalCheatSheets (MCS) -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): +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) @@ -11,8 +11,12 @@ Any contribution will be possible when license is added. ## Usage -`git clone` the repository, then install the dependencies with `bundle install`. -Then, run the server with `bundle exec Jekyll serve`. The server will make the project available at: `http://127.0.0.1:4000/mcs/` +- `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: