zksync lite docs Download - zksync lite docs Quellcode Download

zksync lite docs

Anderer Quellcode

2.31.8

Herunterladen

ZkSync Lite Docs

ZkSync -Dokumentation für den v1 | Changelog

Dieses Repository enthält die zkkSync -Dokumentation, die unter docs.lite.zkksync.io/ gehostet wird

Entwicklung

Voraussetzungen

Eine Node.js -Installation, die node.js Version 16 ausgeführt wird.

Lokallauf

yarn install --check-cache
yarn docs:dev

Entwicklung

Die CI -Pipeline prüft, dass die Dateien gemäß markdownlint -Fundierung keine Probleme in der Dokuments und die Rechtschreibung korrekt sind. Außerdem sollte es keine toten Links geben.

Sie können es lokal wie folgt überprüfen:

yarn
yarn md:lint
yarn cspell

Wenn cspell kein Wort erkennt, aber Sie sind sicher, dass es richtig ist, sollten Sie es dem cspell-zksync.txt hinzufügen.

Einsatz

master Branch wird automatisch in https://console.firebase.google.com/u/0/project/zkksync-web-docs bereitgestellt

Insgesamt bereitstellen

wird tun:

Knotenmodule installieren;
Dokumentation vorbereiten, testen und erstellen;
Danach werden alle, die alle in den dist -Ordner enthalten sind

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

Zusätzliche Dokumentation

Cspell

Konfiguration in cspell.json :

version - Version der Einstellungsdatei, immer 0.1
language - Sprache - Aktuelle aktive Rechtschreibsprache
words[] - Wörter - Liste von Wörtern, die immer als richtig betrachtet werden sollen
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 "
  }
]
}