https://github.com/zkemail/docusaurus
https://github.com/zkemail/docusaurus
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/zkemail/docusaurus
- Owner: zkemail
- License: mit
- Created: 2024-10-07T08:08:26.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-03-25T10:31:13.000Z (about 1 year ago)
- Last Synced: 2025-03-28T06:41:25.705Z (about 1 year ago)
- Language: TypeScript
- Homepage:
- Size: 11.1 MB
- Stars: 1
- Watchers: 1
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: docs/contributing.md
Awesome Lists containing this project
README
# ZK Email Documentation
This repository contains the documentation for ZK Email, built using [Docusaurus](https://docusaurus.io/).
## 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:
```bash
git clone https://github.com/zkemail/docusaurus
cd docs
```
2. Install dependencies:
```bash
yarn
```
3. Copy `.env.example` and add your posthog API key:
```bash
cp .env.example .env
```
4. Start the development server:
```bash
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:
```bash
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](docs/contributing.md) for details.
## License
MIT Licensed. Note that circom and circomlib dependencies are GPL licensed.
## Contact
- [Telegram](https://t.me/zkemail): Community discussions and support
- [X](https://x.com/zkemail): Latest updates