{"id":13746797,"url":"https://github.com/matter-labs/zksync-web-era-docs","last_synced_at":"2025-05-09T07:32:38.371Z","repository":{"id":37441024,"uuid":"414905995","full_name":"matter-labs/zksync-web-era-docs","owner":"matter-labs","description":"zkSync Era Documentation","archived":false,"fork":false,"pushed_at":"2024-05-22T21:15:17.000Z","size":50786,"stargazers_count":952,"open_issues_count":45,"forks_count":841,"subscribers_count":57,"default_branch":"main","last_synced_at":"2024-05-22T22:20:55.176Z","etag":null,"topics":["team-core","team-frontend","zksync","zksync-v2"],"latest_commit_sha":null,"homepage":"https://docs.zksync.io/","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/matter-labs.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":"CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-10-08T08:27:31.000Z","updated_at":"2024-05-22T22:20:55.176Z","dependencies_parsed_at":"2023-11-13T06:26:28.552Z","dependency_job_id":"c030a9c6-17b7-4405-aa80-3cea3b40c2ec","html_url":"https://github.com/matter-labs/zksync-web-era-docs","commit_stats":null,"previous_names":[],"tags_count":177,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/matter-labs%2Fzksync-web-era-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/matter-labs%2Fzksync-web-era-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/matter-labs%2Fzksync-web-era-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/matter-labs%2Fzksync-web-era-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/matter-labs","download_url":"https://codeload.github.com/matter-labs/zksync-web-era-docs/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":224842457,"owners_count":17378980,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["team-core","team-frontend","zksync","zksync-v2"],"created_at":"2024-08-03T06:01:01.831Z","updated_at":"2025-05-09T07:32:38.363Z","avatar_url":"https://github.com/matter-labs.png","language":"JavaScript","funding_links":[],"categories":["Others"],"sub_categories":[],"readme":"\u003e [!WARNING]  \n\u003e zksync-web-era-docs will be archived shortly! \n\u003e Find the latest at [zksync-docs](https://github.com/matter-labs/zksync-docs)\n\u003e \n\u003e For tutorials and guides, check out the [Community Code](https://github.com/zkSync-Community-Hub/community-code) repo.\n\n# zkSync Documentation\n\n[![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/matter-labs/zksync-web-v2-docs?color=%234E529A\u0026label=changelog)](CHANGELOG.md)\n[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/matter-labs/zksync-web-era-docs/blob/main/LICENSE) [![GitHub license](https://img.shields.io/badge/license-Apache%202-blue)](https://github.com/matter-labs/zksync-web-era-docs/blob/main/LICENSE-APACHE)\n[![Follow us!](https://img.shields.io/twitter/follow/zksync?color=%234E529A\u0026label=Follow%20%40zkSync\u0026logo=data%3Aimage%2Fsvg%2Bxml%3Bbase64%2CPHN2ZyB3aWR0aD0iNDMiIGhlaWdodD0iMjUiIHZpZXdCb3g9IjAgMCA0MyAyNSIgZmlsbD0ibm9uZSIgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIj4KPHBhdGggZmlsbC1ydWxlPSJldmVub2RkIiBjbGlwLXJ1bGU9ImV2ZW5vZGQiIGQ9Ik00Mi42NTM5IDEyLjQ5MTVMMzAuODM3OCAwLjcxNjc0M1Y5LjM0TDE5LjEwNTUgMTcuOTczOUwzMC44Mzc4IDE3Ljk4MlYyNC4yNjYyTDQyLjY1MzkgMTIuNDkxNVoiIGZpbGw9IiM0RTUyOUEiLz4KPHBhdGggZmlsbC1ydWxlPSJldmVub2RkIiBjbGlwLXJ1bGU9ImV2ZW5vZGQiIGQ9Ik0wLjk5ODA0NyAxMi40ODcyTDEyLjgxNDEgMjQuMjYxOVYxNS43MDhMMjQuNTQ2NSA3LjAwNDdMMTIuODE0MSA2Ljk5NjY0VjAuNzEyNDYzTDAuOTk4MDQ3IDEyLjQ4NzJaIiBmaWxsPSIjOEM4REZDIi8%2BCjwvc3ZnPgo%3D\u0026style=flat)](https://twitter.com/zksync)\n\n## zkEVM\n\n\u003e zkEVM is a virtual machine that executes smart contracts in a way that is compatible with zero-knowledge-proof computation.\n\u003e Our zkEVM keeps EVM semantics, but is also ZK-friendly and adopts a traditional register-based CPU architecture.\n\n[zkSync Docs](https://docs.zksync.io) contain up-to-date information about **zkSync**.\nzkSync Era has built-in EVM compatibility which makes it a unified tool for releasing EVM-compatible ZK rollups.\n\nWe call it [zkEVM](https://zksync.io/zkevm): web3, Layer 2, scaling functionality that preserves your battle-tested code and knowledge gained after years of working with Solidity.\n\n## Build and setup\n\n### Initial setup\n\nThe frontend team chose the `yarn@berry` package manager, so ensure you install `node` version **LTS@14** after configuring `yarn`.\n\n```bash\n# configure yarn version: berry or specifically 3.1.1.\n$ yarn set version berry\n```\n\n### Main scripts\n\n```bash\n# install dependencies\n$ yarn\n\n# serve with hot reload at localhost:8080\n$ yarn docs:dev\n# static generation to dist\n$ yarn docs:build\n```\n\n### Development\n\nThe 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.\n\nYou can check it locally as follows:\n\n```bash\n# check dead links\n$ yarn lint:dead\n# check spelling\n$ yarn lint:spell\n# check with markdownlint\n$ yarn lint:mdl\n# check with prettier\n$ yarn lint:fmt\n# fix with markdownlint\n$ yarn fix:mdl\n# fix with prettier\n$ yarn fix:fmt\n# run all checks\n$ yarn ci\n# run all fixes\n$ yarn ci:fix\n# build for production\n$ yarn ci:build\n```\n\nIf `lint:spell` doesn't recognize a word, and you’re sure that it’s correct, consider adding it to `cspell-zksync.txt`.\n\n## Search\n\nWe use Algolia to index our documentation. Know more about it [here](https://algolia.com). Dashboard is [here](https://dashboard.algolia.com/), and [Crawler Admin](https://crawler.algolia.com/) is here.\n\n## Contributions\n\n### Adding new tutorials\n\nTo add a new tutorial:\n\n- Fork the repository and create a new branch locally to add your changes.\n- Add the tutorial markdown file inside the `build/tutorials` folder.\n- Give the file an SEO-friendly name, as it is included in the live URL.\n- In the `.vuepress/sidebar/en.ts` file, add the tutorial inside this block:\n\n```js\n{\n  text: \"Tutorials\",\n  link: \"/dev/tutorials\",\n  children: [\n        \"/build/tutorials/cross-chain-tutorial.md\",\n        \"/build/tutorials/custom-aa-tutorial.md\",\n        \"/build/tutorials/aa-daily-spend-limit.md\",\n        \"/build/tutorials/custom-paymaster-tutorial.md\",\n        // ADD YOUR FILE HERE\n  ],\n},\n```\n\n- If your tutorial contains images, make sure to compress them using https://squoosh.app/ before adding them to the `assets/images` folder.\n- Finally, create a PR.\n\n### Deployment\n\nThe `main` branch is automatically deployed to \u003chttps://console.firebase.google.com/u/0/project/aqwzx-zksync-v2-docs\u003e\n\nDeploying does the following:\n\n- Installs node modules.\n- Prepares, tests, and builds documentation.\n- Deploys everything contained in the `dist` folder as a static website.\n\n```bash\nyarn zk-ci-prepare\nyarn firebase deploy\n```\n\n## Extra documentation\n\n## cSpell\n\nConfiguration in `.cSpell.json`:\n\n- `version` — version of the setting file, always **0.1**.\n- `language` — current active spelling language.\n- `words[]` — list of correctly-spelled words.\n- `dictionaries[]`\n\n```json\n\"dictionaryDefinitions\": [\n  {\n    \"name\": \"zksync\", \"path\": \"./cspell-zksync.txt\"\n  }\n]\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmatter-labs%2Fzksync-web-era-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmatter-labs%2Fzksync-web-era-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmatter-labs%2Fzksync-web-era-docs/lists"}