Skip to content

Commit

Permalink
Convert docs from Zola to mdBook (#623)
Browse files Browse the repository at this point in the history
  • Loading branch information
casey authored Oct 6, 2022
1 parent 8754d8c commit 2ed8290
Show file tree
Hide file tree
Showing 24 changed files with 341 additions and 154 deletions.
42 changes: 42 additions & 0 deletions .github/workflows/book.yaml
Original file line number Diff line number Diff line change
@@ -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/checkout@v3.0.0

- 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
21 changes: 0 additions & 21 deletions .github/workflows/build-docs.yaml

This file was deleted.

20 changes: 0 additions & 20 deletions .github/workflows/deploy-docs.yaml

This file was deleted.

1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
/.idea/
/.vagrant
/benchmark
/book/build
/docs/public
/index.lmdb
/index.redb
Expand Down
15 changes: 15 additions & 0 deletions book/book.toml
Original file line number Diff line number Diff line change
@@ -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]
10 changes: 10 additions & 0 deletions book/src/SUMMARY.md
Original file line number Diff line number Diff line change
@@ -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)
16 changes: 4 additions & 12 deletions docs/content/bounty/_index.md β†’ book/src/bounty.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
9 changes: 2 additions & 7 deletions docs/content/bounty/0.md β†’ book/src/bounty/0.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,5 @@
+++
title = "Ordinal Bounty 0"
date = 2022-08-19
[extra]
claimed = true
reward = "100,000 sats"
+++
Ordinal Bounty 0
================

Criteria
--------
Expand Down
9 changes: 2 additions & 7 deletions docs/content/bounty/1.md β†’ book/src/bounty/1.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,5 @@
+++
title = "Ordinal Bounty 1"
date = 2022-08-24
[extra]
claimed = true
reward = "200,000 sats"
+++
Ordinal Bounty 1
================

Criteria
--------
Expand Down
9 changes: 2 additions & 7 deletions docs/content/bounty/2.md β†’ book/src/bounty/2.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,5 @@
+++
title = "Ordinal Bounty 2"
date = 2022-10-03
[extra]
claimed = false
reward = "300,000 sats"
+++
Ordinal Bounty 2
================

Criteria
--------
Expand Down
6 changes: 3 additions & 3 deletions docs/content/faq.md β†’ book/src/faq.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
+++
title = "FAQ"
+++
Ordinal FAQ
===========

How many ordinals will there be?
--------------------------------

Expand Down
5 changes: 2 additions & 3 deletions docs/content/hunting.md β†’ book/src/hunting.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
Loading

0 comments on commit 2ed8290

Please sign in to comment.