Convert docs from Zola to mdBook (ordinals#623)

.github/workflows/book.yaml

@@ -0,0 +1,42 @@
+name: Book
+
+on:
+ pull_request:
+ branches:
+ - master
+ push:
+ branches:
+ - master
+
+defaults:
+ run:
+ shell: bash
+
+jobs:
+ book:
+ runs-on: ubuntu-latest
+ steps:
+ - uses: actions/[email protected]
+
+ - uses: peaceiris/actions-mdbook@v1
+ with:
+ mdbook-version: latest
+
+ - name: Install mdbook-linkcheck
+ run: |
+ mkdir -p mdbook-linkcheck
+ cd mdbook-linkcheck
+ wget https://github.com/Michael-F-Bryan/mdbook-linkcheck/releases/latest/download/mdbook-linkcheck.x86_64-unknown-linux-gnu.zip
+ unzip mdbook-linkcheck.x86_64-unknown-linux-gnu.zip
+ chmod +x mdbook-linkcheck
+ pwd >> $GITHUB_PATH
+
+ - run: mdbook build book
+
+ - name: Deploy Pages
+ uses: peaceiris/actions-gh-pages@v3
+ if: github.ref == 'refs/heads/master'
+ with:
+ github_token: ${{secrets.GITHUB_TOKEN}}
+ publish_branch: gh-pages
+ publish_dir: book/build

.gitignore

@@ -1,6 +1,7 @@
 /.idea/
 /.vagrant
 /benchmark
+/book/build
 /docs/public
 /index.lmdb
 /index.redb

book/book.toml

@@ -0,0 +1,15 @@
+[book]
+title = "Ordinal Hunter's Manual"
+language = "en"
+multilingual = false
+src = "src"
+
+[build]
+build-dir = "build"
+create-missing = false
+
+[output.html]
+cname = "docs.ordinals.com"
+git-repository-url = "https://github.com/casey/ord"
+
+[output.linkcheck]

book/src/SUMMARY.md

@@ -0,0 +1,10 @@
+# Summary
+
+- [Theory](./theory.md)
+- [FAQ](./faq.md)
+- [Ordinal Hunting](./hunting.md)
+
+- [Bounties](./bounty.md)
+ - [Bounty 0: 100,000 sats Claimed!](./bounty/0.md)
+ - [Bounty 1: 200,000 sats Claimed!](./bounty/1.md)
+ - [Bounty 2: 300,000 sats](./bounty/2.md)

docs/content/bounty/_index.md → book/src/bounty.md

@@ -1,21 +1,13 @@
-+++
-title = "Ordinal Bounties"
-page_template = "bounty.html"
-template = "bounties.html"
-sort_by = "date"
-aliases = ["bounties"]
-+++
-
-Hints
------
+Ordinal Bounty Hunting Hints
+============================
 
 - There are no ordinal wallets or transaction construction libraries. However,
  ordinal theory is extremely simple. A clever hacker should be able to write
  code to manipulate ordinals in no time.
 
-- For more information about ordinals, check out the [FAQ](/faq) for an
+- For more information about ordinals, check out the [FAQ](./faq.md) for an
  overview, the [BIP](https://github.com/casey/ord/blob/master/bip.mediawiki)
- for the technical details, and the [ord repo](https://github.com/casey/ord]
+ for the technical details, and the [ord repo](https://github.com/casey/ord)
  for the `ord` wallet and block explorer.
 
 - Satoshi was the original developer of ordinal theory. However, he knew that

docs/content/bounty/0.md → book/src/bounty/0.md

@@ -1,10 +1,5 @@
-+++
-title = "Ordinal Bounty 0"
-date = 2022-08-19
-[extra]
-claimed = true
-reward = "100,000 sats"
-+++
+Ordinal Bounty 0
+================
 
 Criteria
 --------

docs/content/bounty/1.md → book/src/bounty/1.md

@@ -1,10 +1,5 @@
-+++
-title = "Ordinal Bounty 1"
-date = 2022-08-24
-[extra]
-claimed = true
-reward = "200,000 sats"
-+++
+Ordinal Bounty 1
+================
 
 Criteria
 --------

docs/content/bounty/2.md → book/src/bounty/2.md

@@ -1,10 +1,5 @@
-+++
-title = "Ordinal Bounty 2"
-date = 2022-10-03
-[extra]
-claimed = false
-reward = "300,000 sats"
-+++
+Ordinal Bounty 2
+================
 
 Criteria
 --------

docs/content/faq.md → book/src/faq.md

@@ -1,6 +1,6 @@
-+++
-title = "FAQ"
-+++
+Ordinal FAQ
+===========
+
 How many ordinals will there be?
 --------------------------------
 

docs/content/hunting.md → book/src/hunting.md

@@ -1,6 +1,5 @@
-+++
-title = "Ordinal Hunting"
-+++
+Ordinal Hunting
+===============
 
 Ordinal hunting is difficult but rewarding. The feeling of owning a wallet full
 of UTXOs, redolent with the scent of rare and exotic ordinals, is beyond