zksync lite docsダウンロードzksync lite docsソースコードダウンロード

zksync lite docs

その他のソースコード

2.31.8

ダウンロード

zksync liteドキュメント

v1 |のzksyncドキュメントChangelog

このリポジトリには、docs.lite.zksync.io/でホストされているzksyncドキュメントが含まれています

発達

前提条件

node.jsインストールnode.jsバージョン16を実行しています。

ローカルラン

yarn install --check-cache
yarn docs:dev

発達

CI Pipelineは、 markdownlintドキュメントで問題を発見していないことに従ってファイルがフォーマットされていることを確認し、スペルが正しいことを確認します。また、死んだリンクはないはずです。

次のようにローカルで確認できます。

yarn
yarn md:lint
yarn cspell

cspell単語を認識していないが、それが正しいと確信している場合は、 cspell-zksync.txtに追加することを検討してください。

展開

masterブランチは、https://console.firebase.google.com/u/0/project/zksync-web-docsに自動的に展開されます

完全に展開します

します：

ノードモジュールをインストールします。
ドキュメントを準備、テスト、および構築する。
その後、 distフォルダーに含まれるすべてが静的ウェブサイトの形で展開されます

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

追加のドキュメント

cspell

cspell.jsonの構成：

version - 設定ファイルのバージョン、常に0.1
language - 言語 - 現在のアクティブなスペル言語
words[] - 単語 - 常に正しいと見なされる単語のリスト
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 "
  }
]
}