zkEVM is a virtual machine that executes smart contracts in a way that is compatible with zero-knowledge-proof computation. Our zkEVM keeps EVM semantics, but is also ZK-friendly and adopts a traditional register-based CPU architecture.
zkSync Docs contain up-to-date information about zkSync. zkSync Era has built-in EVM compatibility which makes it a unified tool for releasing EVM-compatible ZK rollups. We call it zkEVM: web3, Layer 2, scaling functionality that preserves your battle-tested code and knowledge gained after years of working with Solidity.
The frontend team chose the yarn@berry package manager, so ensure you install node version LTS@14 after configuring yarn.
# configure yarn version: berry or specifically 3.1.1.
$ yarn set version berry# install dependencies
$ yarn
# serve with hot reload at localhost:8080
$ yarn docs:dev
# static generation to dist
$ yarn docs:buildThe continuous integration pipeline uses prettier and markdownlint to ensure there are no issues with your document, that spelling is correct, and there are no dead links.
You can check it locally as follows:
# check dead links
$ yarn lint:dead
# check spelling
$ yarn lint:spell
# check with markdownlint
$ yarn lint:mdl
# check with prettier
$ yarn lint:fmt
# fix with markdownlint
$ yarn fix:mdl
# fix with prettier
$ yarn fix:fmt
# run all checks
$ yarn ci
# run all fixes
$ yarn ci:fix
# build for production
$ yarn ci:buildIf lint:spell doesn't recognize a word, and you’re sure that it’s correct, consider adding it to cspell-zksync.txt.
We use Algolia to index our documentation. Know more about it here. Dashboard is here, and Crawler Admin is here.
To add a new tutorial:
- Fork the repository and create a new branch locally to add your changes.
- Add the tutorial markdown file inside the
build/tutorialsfolder. - Give the file an SEO-friendly name, as it is included in the live URL.
- In the
.vuepress/sidebar/en.tsfile, add the tutorial inside this block:
{
text: "Tutorials",
link: "/dev/tutorials",
children: [
"/build/tutorials/cross-chain-tutorial.md",
"/build/tutorials/custom-aa-tutorial.md",
"/build/tutorials/aa-daily-spend-limit.md",
"/build/tutorials/custom-paymaster-tutorial.md",
// ADD YOUR FILE HERE
],
},- If your tutorial contains images, make sure to compress them using https://squoosh.app/ before adding them to the
assets/imagesfolder. - Finally, create a PR.
The main branch is automatically deployed to https://console.firebase.google.com/u/0/project/aqwzx-zksync-v2-docs
Deploying does the following:
- Installs node modules.
- Prepares, tests, and builds documentation.
- Deploys everything contained in the
distfolder as a static website.
yarn zk-ci-prepare
yarn firebase deployConfiguration in .cSpell.json:
version— version of the setting file, always 0.1.language— current active spelling language.words[]— list of correctly-spelled words.dictionaries[]
"dictionaryDefinitions": [
{
"name": "zksync", "path": "./cspell-zksync.txt"
}
]
![renovate[bot] avatar](https://avatars.githubusercontent.com/in/2740?v=4 "renovate[bot]")
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent