Merge pull request #32 from ethereum-optimism/refcell/fix-mdbook-depl…

…oyment fix: MdBook Deployment
ethereum-optimism · Jul 24, 2024 · 42bf1e3 · 42bf1e3
2 parents 2c23cca + 4f58e4b
commit 42bf1e3
Show file tree

Hide file tree

Showing 6 changed files with 1,304 additions and 2 deletions.
diff --git a/.gitignore b/.gitignore
@@ -6,3 +6,6 @@
 
 # Environment Variables
 .env
+
+# MdBook Artifacts
+book/book/
diff --git a/book/README.md b/book/README.md
@@ -0,0 +1,16 @@
+# OP Test Vectors Book
+
+This repository contains the source code for the OP Test vectors book,
+which is available at [ethereum-optimism.github.io/op-test-vectors](https://ethereum-optimism.github.io/op-test-vectors/).
+
+## Contributing
+
+To build the book locally, a few dependencies are required:
+```sh
+cargo install mdbook mdbook-mermaid mdbook-template
+```
+
+Then, to run the book locally during development, run:
+```sh
+mdbook serve
+```
diff --git a/book/book.toml b/book/book.toml
@@ -2,7 +2,7 @@
 authors = ["refcell"]
 language = "en"
 multilingual = false
-src = "book/src"
+src = "src"
 title = "OP Test Vectors"
 
 [preprocessor.mermaid]

diff --git a/book/mermaid-init.js b/book/mermaid-init.js
@@ -0,0 +1 @@
+mermaid.initialize({ startOnLoad: true, theme: 'dark' });
diff --git a/book/mermaid.min.js b/book/mermaid.min.js
diff --git a/book/src/intro.md b/book/src/intro.md
@@ -1,6 +1,6 @@
 # OP Test Vectors Book
 
-_Documentation for op test vectors._
+_Documentation for the op-test-vectors repository._
 
 ## Introduction
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		mermaid.initialize({ startOnLoad: true, theme: 'dark' });