site: add epub

Author: willcl-ark

Gemfile

@@ -5,6 +5,9 @@ source 'https://rubygems.org'
 ## version.
 ruby '3.2.2'
 
+gem "asciidoctor", "~>2.0.20"
+gem "rouge"
+
 ## If you add a new Gem below, run `bundle install` to install it.
 group :development do
   gem "jekyll", "~> 4.3.2"
@@ -24,7 +27,6 @@ end
 group :asciidoc_plugins do
   gem "asciidoctor-epub3"
   gem "asciidoctor-pdf"
-  gem 'rouge'
 end
 
 group :testing do

Gemfile.lock

@@ -6,13 +6,17 @@ GEM
       public_suffix (>= 2.0.2, < 6.0)
     afm (0.2.2)
     asciidoctor (2.0.20)
-    asciidoctor-diagram (2.2.11)
+    asciidoctor-diagram (2.2.14)
       asciidoctor (>= 1.5.7, < 3.x)
       asciidoctor-diagram-ditaamini (~> 1.0)
       asciidoctor-diagram-plantuml (~> 1.2021)
       rexml
     asciidoctor-diagram-ditaamini (1.0.3)
-    asciidoctor-diagram-plantuml (1.2023.10)
+    asciidoctor-diagram-plantuml (1.2023.12)
+    asciidoctor-epub3 (1.5.1)
+      asciidoctor (>= 1.5.6, < 3.0.0)
+      gepub (~> 1.0.0)
+      mime-types (~> 3.0)
     asciidoctor-pdf (2.3.9)
       asciidoctor (~> 2.0)
       concurrent-ruby (~> 1.1)
@@ -23,12 +27,12 @@ GEM
       prawn-table (~> 0.2.0)
       prawn-templates (~> 0.1.0)
       treetop (~> 1.6.0)
-    async (2.6.3)
+    async (2.6.5)
       console (~> 1.10)
       fiber-annotation
       io-event (~> 1.1)
       timers (~> 4.1)
-    chef-utils (18.2.7)
+    chef-utils (18.3.0)
       concurrent-ruby
     colorator (1.1.0)
     concurrent-ruby (1.2.2)
@@ -43,11 +47,14 @@ GEM
     ethon (0.16.0)
       ffi (>= 1.15.0)
     eventmachine (1.2.7)
-    ffi (1.15.5)
+    ffi (1.16.3)
     fiber-annotation (0.2.0)
     fiber-local (1.0.0)
     forwardable-extended (2.6.0)
-    google-protobuf (3.24.0-x86_64-linux)
+    gepub (1.0.15)
+      nokogiri (>= 1.8.2, < 2.0)
+      rubyzip (> 1.1.1, < 2.4)
+    google-protobuf (3.25.1-x86_64-linux)
     hashery (2.1.2)
     html-proofer (5.0.8)
       addressable (~> 2.3)
@@ -61,7 +68,7 @@ GEM
     http_parser.rb (0.8.0)
     i18n (1.14.1)
       concurrent-ruby (~> 1.0)
-    io-event (1.2.3)
+    io-event (1.3.3)
     jekyll (4.3.2)
       addressable (~> 2.4)
       colorator (~> 1.0)
@@ -78,11 +85,13 @@ GEM
       safe_yaml (~> 1.0)
       terminal-table (>= 1.8, < 4.0)
       webrick (~> 1.7)
-    jekyll-asciidoc (3.0.0)
-      asciidoctor (>= 1.5.0)
+    jekyll-asciidoc (3.0.1)
+      asciidoctor (>= 1.5.0, < 3.0.0)
       jekyll (>= 3.0.0)
     jekyll-feed (0.17.0)
       jekyll (>= 3.7, < 5.0)
+    jekyll-include-cache (0.2.1)
+      jekyll (>= 3.7, < 5.0)
     jekyll-redirect-from (0.16.0)
       jekyll (>= 3.3, < 5.0)
     jekyll-sass-converter (3.0.0)
@@ -91,10 +100,11 @@ GEM
       jekyll (>= 3.8, < 5.0)
     jekyll-watch (2.2.1)
       listen (~> 3.0)
-    json-schema (4.0.0)
+    json-schema (4.1.1)
       addressable (>= 2.8)
-    just-the-docs (0.5.4)
+    just-the-docs (0.7.0)
       jekyll (>= 3.8.5)
+      jekyll-include-cache
       jekyll-seo-tag (>= 2.0)
       rake (>= 12.3.1)
     kramdown (2.4.0)
@@ -106,19 +116,22 @@ GEM
       rb-fsevent (~> 0.10, >= 0.10.3)
       rb-inotify (~> 0.9, >= 0.9.10)
     matrix (0.4.2)
-    mdl (0.12.0)
+    mdl (0.13.0)
       kramdown (~> 2.3)
       kramdown-parser-gfm (~> 1.1)
       mixlib-cli (~> 2.1, >= 2.1.1)
       mixlib-config (>= 2.2.1, < 4)
       mixlib-shellout
     mercenary (0.4.0)
+    mime-types (3.5.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2023.1003)
     mixlib-cli (2.1.8)
     mixlib-config (3.0.27)
       tomlrb
     mixlib-shellout (3.2.7)
       chef-utils
-    nokogiri (1.15.4-x86_64-linux)
+    nokogiri (1.15.5-x86_64-linux)
       racc (~> 1.4)
     parslet (2.0.0)
     pathutil (0.16.2)
@@ -145,18 +158,19 @@ GEM
     prawn-templates (0.1.2)
       pdf-reader (~> 2.0)
       prawn (~> 2.2)
-    public_suffix (5.0.3)
-    racc (1.7.1)
+    public_suffix (5.0.4)
+    racc (1.7.3)
     rainbow (3.1.1)
-    rake (13.0.6)
+    rake (13.1.0)
     rb-fsevent (0.11.2)
     rb-inotify (0.10.1)
       ffi (~> 1.0)
     rexml (3.2.6)
-    rouge (4.1.3)
+    rouge (4.2.0)
     ruby-rc4 (0.1.5)
+    rubyzip (2.3.2)
     safe_yaml (1.0.5)
-    sass-embedded (1.64.2-x86_64-linux-gnu)
+    sass-embedded (1.69.5-x86_64-linux-gnu)
       google-protobuf (~> 3.23)
     terminal-table (3.0.2)
       unicode-display_width (>= 1.1.1, < 3)
@@ -167,18 +181,20 @@ GEM
     treetop (1.6.12)
       polyglot (~> 0.3)
     ttfunk (1.7.0)
-    typhoeus (1.4.0)
+    typhoeus (1.4.1)
       ethon (>= 0.9.0)
-    unicode-display_width (2.4.2)
+    unicode-display_width (2.5.0)
     webrick (1.8.1)
     yell (2.2.2)
-    zeitwerk (2.6.11)
+    zeitwerk (2.6.12)
 
 PLATFORMS
   x86_64-linux
 
 DEPENDENCIES
+  asciidoctor (~> 2.0.20)
   asciidoctor-diagram
+  asciidoctor-epub3
   asciidoctor-pdf
   html-proofer
   jekyll (~> 4.3.2)

Makefile

@@ -57,3 +57,6 @@ build-other-versions:
 	## PDF version
 	bundle exec asciidoctor --attribute imagesdir=./images --attribute mermaid-format=png -r asciidoctor-pdf -b pdf -r asciidoctor-diagram -o onboarding-to-bitcoin-core.pdf index.adoc
 	mv onboarding-to-bitcoin-core.pdf bin/
+	## ePub version
+	asciidoctor -b epub3 -r asciidoctor-epub3 -r asciidoctor-diagram --attribute mermaid-format=png --attribute doctype=book index.adoc
+	mv index.epub bin/onboarding-to-bitcoin-core.epub

index.html

@@ -34,8 +34,8 @@
     <p><b>Get onboarded</b></p>
     <p>Read the <a href="./bin/onboarding-to-bitcoin-core.html">entire onboarding guide</a> in a
     convenient single-page format.</p>
-    <p>Or view the <a href="./bin/onboarding-to-bitcoin-core.pdf">entire guide</a>
-    (excluding mermaid charts) as a PDF.</p>
+    <p>Alternatively, view as a <a href="./bin/onboarding-to-bitcoin-core.pdf">PDF</a> or
+    <a href="./bin/onboarding-to-bitcoin-core.epub">ePub</a>.</p>
   </div>
 
   <div class="dah_card">