تنزيل zksync lite docs - تنزيل zksync lite docs المصدر

zksync lite docs

شفرة المصدر الأخرى

2.31.8

تنزيل

مستندات zksync lite

وثائق Zksync لـ V1 | Changelog

يحتوي هذا المستودع على وثائق Zksync المستضافة في docs.lite.zksync.io/

تطوير

المتطلبات الأساسية

تثبيت Node.js تشغيل Node.js الإصدار 16.

تشغيل محلي

yarn install --check-cache
yarn docs:dev

تطوير

سيتحقق خط أنابيب CI من تنسيق الملفات وفقًا لـ 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 "
  }
]
}