Adding pdf/epub/mobi generation from the markdown files using pandoc

.github/workflows/pandoc.yml

@@ -0,0 +1,82 @@
+name: Pandoc Action
+on: [push,pull_request,workflow_dispatch]
+
+jobs:
+  # This workflow contains a single job called "build"
+  build:
+    # The type of runner that the job will run on
+    runs-on: ubuntu-latest
+
+    # Steps represent a sequence of tasks that will be executed as part of the job
+    steps:
+
+      # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
+      - uses: actions/checkout@v2
+
+      # Runs a single command using the runners shell
+      - name: Pandoc Document Converter pdf
+        uses: Ender-events/pandoc@master
+        with:
+          args: '--pdf-engine=xelatex  --template=assets/templates/eisvogel.latex  --highlight-style zenburn --toc -N --lua-filter _pandoc_filter/image_link.lua  --lua-filter _pandoc_filter/add_title.lua  -o assets/btcguide.pdf  index_pandoc.md'
+      - name: Pandoc Document Converter epub
+        uses: Ender-events/pandoc@master
+        with:
+          args: '--css assets/templates/epub.css --toc -N --lua-filter _pandoc_filter/image_link.lua  --lua-filter _pandoc_filter/add_title.lua  -o assets/btcguide.epub  index_pandoc.md'
+      - name: Install calibre
+        run: sudo apt-get update && sudo apt-get install calibre
+      - name: Convert epub to mobi
+        run: ebook-convert "assets/btcguide.epub" "assets/btcguide.mobi" --mobi-file-type new --pretty-print --mobi-keep-original-images 
+      - name: Get current date
+        id: date
+        run: echo "::set-output name=date::$(date +'%Y-%m-%dT%H-%M')"
+      - name: Create tag
+        uses: actions/github-script@v3
+        with:
+          github-token: ${{ github.token }}
+          script: |
+            github.git.createRef({
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              ref: "refs/tags/${{ steps.date.outputs.date }}",
+              sha: context.sha
+            })
+      - name: Create Release
+        id: create_release
+        uses: actions/[email protected]
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          tag_name: ${{ steps.date.outputs.date }}
+          release_name: Release ${{ steps.date.outputs.date }}
+          draft: false
+          prerelease: false
+      - name: Upload Release Asset pdf
+        id: upload-release-asset-pdf
+        uses: actions/[email protected]
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          upload_url: ${{ steps.create_release.outputs.upload_url }}
+          asset_path: ./assets/btcguide.pdf
+          asset_name: btcguide.pdf
+          asset_content_type: application/pdf
+      - name: Upload Release Asset epub
+        id: upload-release-asset-epub
+        uses: actions/[email protected]
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          upload_url: ${{ steps.create_release.outputs.upload_url }}
+          asset_path: ./assets/btcguide.epub
+          asset_name: btcguide.epub
+          asset_content_type: application/epub
+      - name: Upload Release Asset mobi
+        id: upload-release-asset-mobi
+        uses: actions/[email protected]
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          upload_url: ${{ steps.create_release.outputs.upload_url }}
+          asset_path: ./assets/btcguide.mobi
+          asset_name: btcguide.mobi
+          asset_content_type: application/mobi

.gitignore

@@ -4,3 +4,5 @@ dictionary.dic
 Gemfile.lock
 .DS_Store
 *.swp
+tex2pdf*/*
+assets/btcguide.*

.wordlist.txt

@@ -36,6 +36,7 @@ GBP
 Guillemet
 HODLer
 HODLers
+Holger
 HW
 HWI
 HWIBridge
@@ -58,6 +59,7 @@ Multisig
 Multisignature
 MyNode
 myNode
+Nahrstaedt
 NDA
 Nodl
 Novak
@@ -111,6 +113,7 @@ barcode
 bb
 bip
 bips
+bitbox
 bitcoincore
 bitcoiners
 bitcoinonly
@@ -133,6 +136,7 @@ coldcard
 coldcard's
 coldcardwallet
 colo
+colorlinks
 conf
 config
 configurability
@@ -146,13 +150,15 @@ disablewallet
 diy
 dmg
 dropdown
+ebook
 electrum
 elsif
 endcomment
 endfor
 endif
 endunless
 english
+epub
 exe
 explainer
 faf
@@ -183,18 +189,21 @@ js
 json
 keepkey
 keyspace
+lang
 li
 localhost
 lt
 macOS
 mainnet
+markdownskip
 md
 meatspace
 merkle
 mflaxman
 microSD
 mins
 mitigations
+mobi
 multicoin
 multisig
 multisig's
@@ -203,6 +212,7 @@ nd
 notecards
 ol
 onsetup
+pandoc
 pdf
 pendrive
 php
@@ -246,6 +256,7 @@ stackoverflow
 stateful
 testnet
 th
+titlepage
 tpub
 tradeoff
 tradeoffs
@@ -257,6 +268,7 @@ udev
 ul
 unencrypted
 url
+urlcolor
 usb
 useability
 utxo

README.md

@@ -20,3 +20,23 @@ Spelling check passed :)
 Notes:
 * See `.wordlist.txt` for all the exception words.
 * `$ brew install aspell && pip install pyspelling` are needed.
+
+
+## Create pdf/epub/mobi
+1. Install [latex](https://www.latex-project.org/get/)
+1. Install [pandoc](https://pandoc.org/installing.html)
+
+
+1. Build the documents with
+
+```
+create_pdf.bat
+create_ebook.bat
+```
+or
+```
+create_pdf.sh
+create_ebook.sh
+```
+1. The mobi file can be created from the epub file using [kindle previewer](https://www.amazon.com/gp/feature.html?ie=UTF8&docId=1003018611)
+