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

.gitignore

@@ -153,3 +153,6 @@ dist
 
 # built files
 build/
+
+# Vim undo file
+*.un~

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

@@ -22,6 +22,10 @@ Have you found your way here from the Internet? That's fine too. Feel free to ch
 - You can use `/` or `Ctrl + K` to open the search bar.
 - You can use `l` to navigate to a specific level.
 
+## E-Book Format
+
+If you want to read this website on an e-reader or simply access it offline, you can download the [epub version](https://hanabi.github.io/assets/epub/hgroup-conventions.epub). (The epub is automatically generated by a script.)
+
 ## Contributing
 
 If you want to contribute to this website, then see the [README.md](https://github.com/hanabi/hanabi.github.io/blob/main/README.md) for the repository and [the documentation on how to create example images](example-images.mdx).