ZK Email Documentation

This repository contains the documentation for ZK Email, built using Docusaurus.

What's Inside

• Documentation: Comprehensive guides and references for:
  • ZK Email SDK: Build custom email verification circuits
  • Email Wallet: Smart contract wallet controlled via email
  • Account Recovery: Secure account recovery through email verification
  • JWT Transaction Builder: Anonymous JWT signature verification
  • Email Transaction Builder: Execute blockchain actions via email
  • ZK Email Verifier: Core library for email verification

Running Locally

1. Clone the repository:

git clone https://github.com/zkemail/docusaurus
cd docs

2. Install dependencies:

yarn

3. Copy .env.example and add your posthog API key:

cp .env.example .env

4. Start the development server:

yarn start

This will start a local development server at http://localhost:3000 and open your browser. Most changes are reflected live without needing to restart the server.

Building

Generate a static build:

yarn build

This generates static content in the build directory that can be served using any static hosting service.xss

Contributing

Please read our Contributing Guide for details.

License

MIT Licensed. Note that circom and circomlib dependencies are GPL licensed.

Contact

• Telegram: Community discussions and support
• X: Latest updates