spec: Shwap

.github/workflows/github_pages.yml

@@ -25,6 +25,27 @@ jobs:
         with:
           mdbook-version: "latest"
 
+      - name: Install mdbook-webinclude preprocessor
+        uses: actions-rs/[email protected]
+        with:
+          crate: mdbook-webinclude
+          version: latest
+          use-tool-cache: true
+
+      - name: Install mdbook-yml-header preprocessor
+        uses: actions-rs/[email protected]
+        with:
+          crate: mdbook-yml-header
+          version: latest
+          use-tool-cache: true
+
+      - name: Install mdbook-pagetoc preprocessor
+        uses: actions-rs/[email protected]
+        with:
+          crate: mdbook-pagetoc
+          version: latest
+          use-tool-cache: true
+
       - name: Build book
         run: mdbook build specs
 

specs/.gitignore

@@ -1 +1,2 @@
 book
+theme

specs/book.toml

@@ -5,9 +5,13 @@ multilingual = false
 src = "src"
 title = "Celestia Node Specification"
 
+[preprocessor.webinclude] # Necessary to retrieve and render external documents like CIPs
+[preprocessor.yml-header] # Necessary to remove front-matter headers that mdbook cannot render
+[preprocessor.pagetoc] # Generates nice and handy toc on the left side of a page
+
 [output.html]
 git-repository-url = "https://github.com/celestiaorg/celestia-node"
 
-[preprocessor.toc]
-command = "mdbook-toc"
-renderer = ["html"]
+# Necessary for pagetoc to work
+additional-css = ["theme/pagetoc.css"]
+additional-js  = ["theme/pagetoc.js"]

specs/src/SUMMARY.md

@@ -1,3 +1,3 @@
 # Summary
 
-- [WIP](./WIP.md)
+- [Shwap](./shwap/spec.md)

specs/src/shwap/spec.md

@@ -0,0 +1 @@
+{{#webinclude https://raw.githubusercontent.com/Wondertan/CIPs/cip-shwap_protocol/cips/cip-shwap_protocol.md}} <!-- markdownlint-disable -->