From edff32fe5e84f764f522945719c11d4975182a91 Mon Sep 17 00:00:00 2001 From: Wizz Wallet <153743376+wizz-wallet-dev@users.noreply.github.com> Date: Fri, 22 Nov 2024 15:25:02 +0800 Subject: [PATCH] =?UTF-8?q?=E2=99=BB=EF=B8=8F=20Migrate=20to=20mdbook?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .github/workflows/gh-pages.yml | 1 + .gitignore | 10 +--------- README.md | 4 ---- SUMMARY.md | 5 +++-- book.toml | 10 ++++++++++ 5 files changed, 15 insertions(+), 15 deletions(-) create mode 100644 book.toml diff --git a/.github/workflows/gh-pages.yml b/.github/workflows/gh-pages.yml index 6a5724d..188f5b3 100644 --- a/.github/workflows/gh-pages.yml +++ b/.github/workflows/gh-pages.yml @@ -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 diff --git a/.gitignore b/.gitignore index 077d6b8..5bcdd20 100644 --- a/.gitignore +++ b/.gitignore @@ -1,10 +1,6 @@ .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 @@ -12,8 +8,4 @@ node_modules # Book build output _book - -# eBook build output -*.epub -*.mobi -*.pdf +book diff --git a/README.md b/README.md index 9e59e15..01ba57b 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,3 @@ ---- -description: An Introduction to Atomicals Theory and Digital Objects on Bitcoin ---- - # Introduction

Atomicals Protocol brings Digital Objects to life on Bitcoin and proof-of-work based blockchains.

diff --git a/SUMMARY.md b/SUMMARY.md index aba11b7..2979a92 100644 --- a/SUMMARY.md +++ b/SUMMARY.md @@ -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) diff --git a/book.toml b/book.toml new file mode 100644 index 0000000..ed0ffc4 --- /dev/null +++ b/book.toml @@ -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"]