ebaizel / zksync-docs

zkSync documentation

zkSync.io · zkSync docs

Website zkSync.io

First public release of the updated zkSync.io landing page design

CHANGELOG

Build Setup

# clear possible cache && install dependencies (clear install)
$ sh cli-dev.sh ci

# populate .env file as dev environment && serve with hot reload at localhost:3000
$ yarn dev

# build for dev
$ build:stage
# afterward you'll have prepared distributive in /public folder

# build for production (only if you have firebase:auth) 
$ bash cli-dev.sh ci && yarn zk-ci-prepare 

For detailed explanation on how things work, check out Nuxt.js docs.

---

Solutions used

• Nuxt.js
• TS Lang
• Vue.js

zkSync docs

This repository contains the zkSync documentation hosted on <zksync.io>.

Local testing

yarn
yarn docs:dev

Development

CI pipeline will check that the files are formatted according to prettier, markdownlint founds no issues in document and spelling is correct. Also, there should be no dead links.

You can check it locally as follows:

yarn
yarn md:lint
yarn md:deadlinks
yarn fmt:check
yarn cspell

If cspell doesn't recognize a word but you're sure that it's correct, consider adding it to the cspell-zksync.txt.

Deployment

master branch is automatically deployed to https://console.firebase.google.com/u/0/project/zksync-js-docs

Deploying altogether

will do:

• install node modules;
• prepare, test and build documentation;
• prepare and build nuxt.js-version of the landing page of zksync.io/index.html
• afterwards all contained into the dist folder will be deployed in form of the static website

yarn zk-ci-prepare
yarn firebase deploy

Extra documentation

cSpell

Configuration in .cSpell.json:

• version — version of the setting file, always 0.1
• language — language - current active spelling language
• words[] — words - list of words to be always considered correct
• dictionaries[]

"dictionaryDefinitions": [
    {
      "name": "zksync", "path": "./cspell-zksync.txt"
    }
]

{
  
  "version": "0.1",
  // language - current active spelling language
  "language": "en",
  // words - list of words to be always considered correct
  "words": [],
  "dictionaries": ["typescript", "zksync"],
  //
  "dictionaryDefinitions": [
  { 
    "name": "zksync", "path": "./cspell-zksync.txt"
  }
]
}