Rossbugginsnhs/2025 10 14/docs rendering 001 (#50)

* prettier.

* prettier.

* update build for webpack.

* docs update.

* docs update with icons.

* make some async.

Author: RossBugginsNHS

.prettierignore

@@ -4,3 +4,4 @@
 **/.hg
 **/node_modules
 **/package-lock.json
+docs/assets/js/zzzz-search-data.json

docs/.gitignore

@@ -9,3 +9,6 @@ node_modules
 _config.version.yml
 schemas
 _data/schema
+assets-webpack/*
+Gemfile-dev.lock
+Gemfile.lock

docs/Gemfile

@@ -17,6 +17,8 @@ gem "jekyll", "~> 4.4.1"
 group :jekyll_plugins do
   gem "jekyll-feed", "~> 0.12"
   gem "jekyll-drawio"
+  gem "jekyll-pdf-embed"
+  gem 'jekyll-random'
 end
 
 # Windows and JRuby does not include zoneinfo files, so bundle the tzinfo-data gem
@@ -37,3 +39,6 @@ gem "just-the-docs", "~> 0.10.1"
 gem 'jemoji'
 
 gem 'sass-embedded', '1.78'
+gem 'jekyll-webpack'
+
+gem 'rubocop', require: false

docs/Gemfile-dev

@@ -0,0 +1,43 @@
+source "https://rubygems.org"
+# Hello! This is where you manage which Jekyll version is used to run.
+# When you want to use a different version, change it below, save the
+# file and run `bundle install`. Run Jekyll with `bundle exec`, like so:
+#
+#     bundle exec jekyll serve
+#
+# This will help ensure the proper Jekyll version is running.
+# Happy Jekylling!
+gem "jekyll", "~> 4.4.1"
+# This is the default theme for new Jekyll sites. You may change this to anything you like.
+#gem "minima", "~> 2.5"
+gem "rake"
+gem "just-the-docs", "~> 0.10.1"
+gem 'sass-embedded', '1.78'
+gem 'jekyll-webpack'
+
+
+# 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-pdf-embed"
+  gem 'jekyll-random'
+  gem "jekyll-feed", "~> 0.12"
+  gem "jekyll-drawio"
+end
+# Windows and JRuby does not include zoneinfo files, so bundle the tzinfo-data gem
+# and associated library.
+platforms :mingw, :x64_mingw, :mswin, :jruby do
+  gem "tzinfo", "~> 1.2"
+  gem "tzinfo-data"
+end
+
+# Performance-booster for watching directories on Windows
+gem "wdm", "~> 0.1.1", :platforms => [:mingw, :x64_mingw, :mswin]
+gem 'jemoji'
+# Lock `http_parser.rb` gem to `v0.6.x` on JRuby builds since newer versions of the gem
+# do not have a Java counterpart.
+gem "http_parser.rb", "~> 0.6.0", :platforms => [:jruby]
+
+gem 'rubocop', require: false

docs/Gemfile.lock

@@ -13,6 +13,7 @@ GEM
       tzinfo (~> 2.0)
     addressable (2.8.7)
       public_suffix (>= 2.0.2, < 7.0)
+    ast (2.4.3)
     base64 (0.2.0)
     bigdecimal (3.1.8)
     cgi (0.4.2)
@@ -66,12 +67,19 @@ GEM
       jekyll (>= 3.7, < 5.0)
     jekyll-include-cache (0.2.1)
       jekyll (>= 3.7, < 5.0)
+    jekyll-pdf-embed (1.1.3)
+      jekyll
+    jekyll-random (0.1)
+      jekyll (>= 3.3, < 5.0)
     jekyll-sass-converter (3.1.0)
       sass-embedded (~> 1.75)
     jekyll-seo-tag (2.8.0)
       jekyll (>= 3.8, < 5.0)
     jekyll-watch (2.2.1)
       listen (~> 3.0)
+    jekyll-webpack (0.2.7)
+      jekyll
+      listen
     jemoji (0.13.0)
       gemoji (>= 3, < 5)
       html-pipeline (~> 2.2)
@@ -86,6 +94,8 @@ GEM
       rexml (>= 3.3.9)
     kramdown-parser-gfm (1.1.0)
       kramdown (~> 2.0)
+    language_server-protocol (3.17.0.5)
+    lint_roller (1.1.0)
     liquid (4.0.4)
     listen (3.9.0)
       rb-fsevent (~> 0.10, >= 0.10.3)
@@ -95,16 +105,38 @@ GEM
     mutex_m (0.2.0)
     nokogiri (1.18.9-x86_64-linux-gnu)
       racc (~> 1.4)
+    parallel (1.27.0)
+    parser (3.3.9.0)
+      ast (~> 2.4.1)
+      racc
     pathutil (0.16.2)
       forwardable-extended (~> 2.6)
+    prism (1.5.2)
     public_suffix (6.0.2)
     racc (1.8.1)
+    rainbow (3.1.1)
     rake (13.2.1)
     rb-fsevent (0.11.2)
     rb-inotify (0.11.1)
       ffi (~> 1.0)
+    regexp_parser (2.11.3)
     rexml (3.4.4)
     rouge (4.6.1)
+    rubocop (1.81.1)
+      json (~> 2.3)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.1.0)
+      parallel (~> 1.10)
+      parser (>= 3.3.0.2)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 2.9.3, < 3.0)
+      rubocop-ast (>= 1.47.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 4.0)
+    rubocop-ast (1.47.1)
+      parser (>= 3.3.7.2)
+      prism (~> 1.4)
+    ruby-progressbar (1.13.0)
     safe_yaml (1.0.5)
     sass-embedded (1.78.0-x86_64-linux-gnu)
       google-protobuf (~> 4.27)
@@ -123,8 +155,12 @@ DEPENDENCIES
   jekyll (~> 4.4.1)
   jekyll-drawio
   jekyll-feed (~> 0.12)
+  jekyll-pdf-embed
+  jekyll-random
+  jekyll-webpack
   jemoji
   just-the-docs (~> 0.10.1)
+  rubocop
   sass-embedded (= 1.78)
   tzinfo (>= 1, < 3)
   tzinfo-data

docs/Makefile

@@ -25,7 +25,7 @@ install:
 	bundle install
 
 s serve:
-	bundle exec jekyll serve --trace --livereload
+	npm run
 
 define baseurlparam =
 $(if $(BASE_URL),-- --baseurl $(BASE_URL),-- --baseurl "")

docs/_config.yml

@@ -40,10 +40,11 @@ plugins:
   - jemoji
 
 #color_scheme: nhs
-mermaid:
-  # Version of mermaid library
-  # Pick an available version from https://cdn.jsdelivr.net/npm/mermaid/
-  version: "11.12.0"
+color_scheme: ce
+# mermaid:
+#   # Version of mermaid library
+#   # Pick an available version from https://cdn.jsdelivr.net/npm/mermaid/
+#   version: "11.12.0"
 
 aux_links:
   "NHS Notify Digital Letters on GitHub":

docs/_includes/fullscreen.html

@@ -1,3 +1,8 @@
 <button type="button" name="fullScreenButton" id="fullScreenButton" class="btn" onclick="fullScreenToggle()">
   Full Screen View
 </button>
+
+<input type="checkbox" id="fullscreenCheckbox" name="fullscreenCheckbox" title="Full Screen"
+  style="visibility: hidden;">
+<label for="fullscreenCheckbox" class="text-small text-grey-dk-000 mb-0" style="visibility: hidden;"> Full
+  Screen</label>

docs/_includes/head_custom.html

@@ -0,0 +1,12 @@
+<script type="text/javascript" src="{{ '/assets/js/imageopen.js' | relative_url }}"></script>
+<script type="text/javascript" src="{{ '/assets/js/nhs-notify.js' | relative_url }}"></script>
+<script type="text/javascript" src="{{ '/assets-webpack/js/main.js' | relative_url }}"></script>
+
+
+<script type="module">
+    await window.nhsce.UseMermaid(document);
+    $(document).ready(function() {
+        window.nhsce.hookFullScreen();
+    });
+</script>
+<link rel="stylesheet" href="{{ '/assets-webpack/css/main.css' | relative_url }}">

docs/_plugins/rawcontent.rb

@@ -0,0 +1,16 @@
+module Jekyll
+  class RawContent < Generator
+    def generate(site)
+      site.collections.each do |collection|
+        collection.each do |label, docs|
+          docs = [label] if label.is_a?(Jekyll::Document)
+          next if docs.nil?
+
+          docs.each do |doc|
+            doc.data['raw_content'] = doc.content.dup
+          end
+        end
+      end
+    end
+  end
+end