Téléchargement zksync lite docs - zksync lite docs Téléchargement du code source

zksync lite docs

Autre code source

2.31.8

Télécharger

Zksync Lite Docs

Documentation Zksync pour le V1 | Changelog

Ce référentiel contient la documentation Zksync hébergée sur docs.lite.zksync.io/

Développement

Condition préalable

Une installation Node.js exécutant Node.js version 16.

Course locale

yarn install --check-cache
yarn docs:dev

Développement

Le pipeline CI vérifiera que les fichiers sont formatés selon markdownlint ne trouve aucun problème dans le document et l'orthographe est correcte. De plus, il ne devrait pas y avoir de liens morts.

Vous pouvez le vérifier localement comme suit:

yarn
yarn md:lint
yarn cspell

Si cspell ne reconnaît pas un mot mais que vous êtes sûr que c'est correct, envisagez de l'ajouter au cspell-zksync.txt .

Déploiement

master Branch est automatiquement déployé sur https://console.firebase.google.com/u/0/project/zksync-web-docs

Déploiement complètement

ça ira:

installer des modules de nœud;
Préparer, tester et construire la documentation;
Ensuite, tout ce qui est contenu dans le dossier dist sera déployé sous forme de site Web statique

yarn install --check-cache
yarn docs:build
yarn firebase deploy

Documentation supplémentaire

cspell

Configuration dans cspell.json :

version - Version du fichier de réglage, toujours 0.1
language - Langue - Langue d'orthographe active actuelle
words[] - mots - liste de mots à être toujours considéré comme 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 "
  }
]
}