Your Notes

Your Description Here

Setup

We use mdBook along with several plugins:

• mdbook-katex for math displays.
• mdbook-mermaid for MermaidJS renders.
• mdbook-toc for table of contents.
• css is a custom CSS to align Mermaid outputs to center.

You need to have Rust installed for all of this.

Usage

After setup is complete, you can use the following commands:

# serve
mdbook serve --open

# build
mdbook build

Tip

You can also use these scripts via make.

The book content is written under the content folder; this allows for some code examples to be written under src and some tests under tests if need be.

Deploy to Vercel

The provided workflow deploys to Vercel on workflow dispatch (though feel free to make it trigger on each push). For the workflow, you need to provide some repository secrets to the GitHub repo:

• VERCEL_TOKEN: Vercel token for the project
• VERCEL_ORG_ID: Vercel organization ID, or your user ID
• VERCEL_PROJECT_ID: Vercel project ID

Examples

• circom.erhant.me
• crypto.erhant.me
• math.erhant.me

License

This repository is MIT licensed, see LICENSE.