From 681e803c4fdf75f4a2e1300d750d994797e91603 Mon Sep 17 00:00:00 2001 From: Mike McQuaid Date: Thu, 24 Apr 2025 09:49:17 +0100 Subject: [PATCH] docs: improve/fix jekyll setup --- .gitignore | 1 - docs/Brewfile | 4 ++++ docs/Gemfile | 4 ++++ docs/bin/jekyll | 27 +++++++++++++++++++++++++++ 4 files changed, 35 insertions(+), 1 deletion(-) create mode 100644 docs/Brewfile create mode 100755 docs/bin/jekyll diff --git a/.gitignore b/.gitignore index 9911feaa46..bb824a889e 100644 --- a/.gitignore +++ b/.gitignore @@ -171,7 +171,6 @@ # Ignore generated documentation site /docs/_site -/docs/bin /docs/.jekyll-metadata /docs/vendor /docs/Gemfile.lock diff --git a/docs/Brewfile b/docs/Brewfile new file mode 100644 index 0000000000..ba9c32db88 --- /dev/null +++ b/docs/Brewfile @@ -0,0 +1,4 @@ +# frozen_string_literal: true + +brew "ruby", version_file: ".ruby-version" +brew "xz" diff --git a/docs/Gemfile b/docs/Gemfile index 12ef85fa97..5d7f077016 100644 --- a/docs/Gemfile +++ b/docs/Gemfile @@ -6,6 +6,10 @@ ruby file: ".ruby-version" gem "github-pages", group: :jekyll_plugins +gem "csv" +gem "faraday-retry" +gem "logger" + group :test do gem "html-proofer" gem "mdl" diff --git a/docs/bin/jekyll b/docs/bin/jekyll new file mode 100755 index 0000000000..d2e20b599e --- /dev/null +++ b/docs/bin/jekyll @@ -0,0 +1,27 @@ +#!/usr/bin/env ruby +# frozen_string_literal: true + +# +# This file was generated by Bundler. +# +# The application 'jekyll' is installed as part of a gem, and +# this file is here to facilitate running it. +# + +ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../Gemfile", __dir__) + +bundle_binstub = File.expand_path("bundle", __dir__) + +if File.file?(bundle_binstub) + if File.read(bundle_binstub, 300).include?("This file was generated by Bundler") + load(bundle_binstub) + else + abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run. +Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.") + end +end + +require "rubygems" +require "bundler/setup" + +load Gem.bin_path("jekyll", "jekyll")