ZKsync SDK Docs

Welcome to the ZKsync SDK Docs repository. This project is for documenting the SDKs available for ZKsync development.

🚀 Quick Start

1. Install Bun: Follow the installation instructions.

2. Install Dependencies:

   bun install

3. Run Locally: Start the development server at http://localhost:3000.

   bun run dev

🛠️ Built With

• Vue
• Nuxt
• Nuxt Content
• Nuxt UI & Nuxt UI Pro
• Tailwind
• Bun

👀 Local Preview

To locally preview the production build, first run bun run build to build the project, then run the following:

bun run preview

✨ Lint & Formatting

This project provides lint commands to check the project.

Run CI Checks ✔️

This command will run all of the lint commands together.

bun run ci:check

Markdown Linting 📝

Markdown files are found in the /content directory. The following lint commands will run within that directory:

bun run lint:spelling
bun run lint:markdown

Linting 🧹

The following commands are available to run code linting on the project:

bun run lint:prettier
bun run lint:eslint

🤝 Contributions

The ZKsync SDK Docs is open for editing by maintainers and contributors of 3rd-party SDKs for ZKsync. Read through the Contribution Guidelines to learn how to follow recommended development practices.

Follow the recommended guidelines for writing content on the ZKsync Docs website.