Skip to content

Commit

Permalink
♻️ Migrate to mdbook
Browse files Browse the repository at this point in the history
  • Loading branch information
wizz-wallet-dev committed Nov 22, 2024
1 parent 6639184 commit edff32f
Show file tree
Hide file tree
Showing 5 changed files with 15 additions and 15 deletions.
1 change: 1 addition & 0 deletions .github/workflows/gh-pages.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ jobs:
uses: peaceiris/actions-mdbook@v2
with:
mdbook-version: 'latest'
- run: cargo install mdbook mdbook-katex
- run: mdbook build
- name: Deploy
uses: peaceiris/actions-gh-pages@v3
Expand Down
10 changes: 1 addition & 9 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,19 +1,11 @@
.idea/
.vscode/

# Node rules:
## Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
.grunt

## Dependency directory
## Commenting this out is preferred by some people, see
## https://docs.npmjs.com/misc/faq#should-i-check-my-node_modules-folder-into-git
node_modules

# Book build output
_book

# eBook build output
*.epub
*.mobi
*.pdf
book
4 changes: 0 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,3 @@
---
description: An Introduction to Atomicals Theory and Digital Objects on Bitcoin
---

# Introduction

<figure><img src="./assets/atomblack.jpg" alt=""><figcaption><p>Atomicals Protocol brings Digital Objects to life on Bitcoin and proof-of-work based blockchains.</p></figcaption></figure>
Expand Down
5 changes: 3 additions & 2 deletions SUMMARY.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# Table of contents
# Summary

[Introduction](README.md)

* [Introduction](README.md)
* [NFTs](nfts/README.md)
* [Normal Transfer Rules](nfts/normal-transfer-rules.md)
* [Swap Transfer Rules](nfts/swap-transfer-rules.md)
Expand Down
10 changes: 10 additions & 0 deletions book.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
[book]
title = "Atomicals Protocol Guide"
description = "An Introduction to Atomicals Theory and Digital Objects on Bitcoin."
authors = ["Atomicals Community"]
language = "en"
multilingual = false
src = "."

[preprocessor.katex]
after = ["links"]

0 comments on commit edff32f

Please sign in to comment.