Skip to content

Documentation for 3rd-party SDKs that integrate with zkSync

License

Apache-2.0, MIT licenses found

Licenses found

Apache-2.0
LICENSE-APACHE
MIT
LICENSE-MIT
Notifications You must be signed in to change notification settings

zksync-sdk/sdk-docs

This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Folders and files

NameName
Last commit message
Last commit date

Latest commit

e214004 Β· Jul 26, 2024

History

32 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

ZKsync SDK Docs

License License: Apache 2.0 Contributor Covenant Contributions Welcome X (formerly Twitter) Follow

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

πŸ‘€ 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.