zksync-web-era-docs - zkSync Era 文档

Created at: 2021-10-08 16:27:31
Language: JavaScript
License: MIT

zkSync Era 文档

GitHub 发布(最新 SemVer) GitHub 许可证 GitHub 许可证 关注我们!

zkEVM

zkEVM是一个虚拟机,它以与零知识证明计算兼容的方式执行智能合约。我们的 zkEVM 保留了 EVM 语义,但也对 ZK 友好,并采用了传统的 CPU 架构。

不断更新,zkSync Era Docs提供有关即将到来的zkSync Era的最完整的知识。zkSync Era 版本具有内置的 EVM 兼容性,这使得它成为发布与 EVM 兼容的 ZK 汇总的单一密钥。我们称之为zkEVM:期待已久的方法,用于保存经过多年使用Solidity使用第2层扩展后获得的经过实战测试的代码和知识。

构建和设置

初始设置

前端团队选择了打包程序,所以不要忘记在配置后安装版本 LTS@14

yarn@berry
node
yarn

# configure yarn version: berry or specifically 3.1.1.
$ yarn set version berry

主要脚本

# install dependencies
$ yarn add

# serve with hot reload at localhost:8080
$ yarn docs:dev
# static generation to dist
$ yarn docs:build

发展

CI 管道将检查文件是否根据 进行格式化,未发现文档中的问题以及拼写是否正确。此外,不应该有死链接。

prettier
markdownlint

你可以在本地检查,如下所示:

# 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:build

如果无法识别某个单词,但你确定它是正确的,请考虑将其添加到 .

lint:spell
cspell-zksync.txt

贡献

添加新教程

要添加新教程,请执行以下操作:

  • 分叉存储库并在本地创建新分支以添加更改。
  • 在文件夹中添加教程降价文件。
    docs/dev/tutorials
  • 为文件指定一个 SEO 友好的名称,因为它将成为 URL 的一部分。
  • 在文件中,在此块中添加教程:
    docs/.vuepress/config.js
{
title: "Tutorials",
path: "/dev/tutorials",
collapsable: false,
children: [
  "/dev/tutorials/cross-chain-tutorial.md",
  "/dev/tutorials/custom-aa-tutorial.md",
  "/dev/tutorials/custom-paymaster-tutorial.md"],
  // ADD YOUR FILE HERE
},
  • 如果你的教程包含图像,请确保在将它们添加到文件夹之前使用 https://squoosh.app/ 压缩它们。
    docs/assets/images
  • 最后,创建一个 PR。

部署

main
分支自动部署到 https://console.firebase.google.com/u/0/project/aqwzx-zksync-v2-docs

完全部署

会做:

  • 安装节点模块;
  • 准备、测试和构建文档;
  • 之后,所有包含在文件夹中的内容都将以静态网站的形式部署
    dist
yarn zk-ci-prepare
yarn firebase deploy

额外文档

cSpell

中的配置 :

.cSpell.json

  • version
    — 设置文件的版本,始终为 0.1
  • language
    — 语言 - 当前有效的拼写语言
  • words[]
    — 单词 - 始终被认为是正确的单词列表
  • dictionaries[]
"dictionaryDefinitions": [
  {
    "name": "zksync", "path": "./cspell-zksync.txt"
  }
]