Implements EPUB transformer (#1350)

.github/workflows/ci.yml

@@ -12,6 +12,12 @@ jobs:
 
       # @template-customization-start
 
+      - uses: actions/setup-python@v6
+        with:
+          python-version: "3.13"
+          cache: pip
+      - run: pip install -r scripts/requirements.txt
+      - run: ./scripts/epub.sh
       - uses: actions/upload-artifact@v4
         with:
           name: build

cspell.config.jsonc

@@ -34,6 +34,8 @@
     "ated",
     "bauza",
     "BCME",
+    "baseprofile",
+    "beautifulsoup",
     "blueviolet",
     "cluable",
     "cluer",
@@ -53,9 +55,22 @@
     "dilorenzo",
     "discardable",
     "discarder",
+    "dtbncx",
     "duneaught",
     "esbenp",
+    "epub",
     "ESDCM",
+    "fecolormatrix",
+    "fecomponenttransfer",
+    "feflood",
+    "fefunca",
+    "fefuncb",
+    "fefuncg",
+    "fefuncr",
+    "femerge",
+    "femergenode",
+    "femorphology",
+    "feoffset",
     "finesseable",
     "fireheart",
     "floriman",
@@ -64,14 +79,17 @@
     "hanab",
     "hanabi",
     "hanabornoob",
+    "hgroup",
     "hideable",
     "iamjeff",
     "iamwhoiamhahaha",
+    "idref",
     "incentivized",
     "indego",
     "infima",
     "informalness",
     "isdariel",
+    "itemref",
     "iwguntoks",
     "jenn",
     "joelwool",
@@ -83,11 +101,20 @@
     "libster",
     "lightgreen",
     "lilliana",
+    "lineargradient",
+    "lxml",
     "mcvp",
+    "Mergenode",
     "metagame",
     "micerang",
     "misranked",
+    "navlabel",
+    "navmap",
+    "navpoint",
+    "NISO",
+    "OEBPS",
     "offsetblur",
+    "opendocument",
     "pianoblook",
     "playstyle",
     "PPCL",
@@ -99,6 +126,8 @@
     "razvogor",
     "rnrgames",
     "romain",
+    "rootfile",
+    "rootfiles",
     "rubbo",
     "rygb",
     "rygbi",
@@ -114,9 +143,11 @@
     "speedruns",
     "starcraft",
     "sucubis",
+    "svgs",
     "tccm",
     "tobin",
     "tocm",
+    "unallowed",
     "uncluable",
     "unclued",
     "unifiedjs",
@@ -125,9 +156,11 @@
     "utpf",
     "uutd",
     "valetta",
+    "viewbox",
     "xdragun",
     "xiwguntoks",
     "xlink",
+    "xmlified",
     "xrbm",
     "xrygb",
     "xrygbi",

docs/about.mdx

@@ -8,6 +8,10 @@ Are you looking to start playing games with the _H-Group_? Head on over to [the
 
 Have you found your way here from the Internet? That's fine too. Feel free to cherry-pick strategies for your own group, or even adopt the whole convention framework. We enjoy talking to other Hanabi players, so make sure to say hi in the Discord server as well. (Discord is a voice and text chat application that you can run in a browser.)
 
+## E-Book Format
+
+For those who'd prefer to read this guide on an e-reader or simply access it offline, you can download the [epub version](https://hanabi.github.io/assets/epub/hgroup-conventions.epub). Please note that the epub version is an automatically converted version of the documentation at [hanabi.github.io](https://hanabi.github.io) and may therefore contain some content intended for the web version (e.g. this page's [Hotkeys section](#hotkeys)).
+
 ## Other Quick Links
 
 - [The rules of the game](https://github.com/hanabi/hanabi.github.io/blob/main/misc/rules.md) (written)