ดาวน์โหลด zksync lite docs - zksync lite docs ซอร์สโค้ดดาวน์โหลดดาวน์โหลดซอร์สโค้ดดาวน์โหลด

zksync lite docs

ซอร์สโค้ดอื่น ๆ

2.31.8

ดาวน์โหลด

zksync lite docs

เอกสาร zksync สำหรับ V1 | การเปลี่ยนแปลง

ที่เก็บนี้มีเอกสาร zksync โฮสต์ที่ docs.lite.zksync.io/

การพัฒนา

ข้อกำหนดเบื้องต้น

การติดตั้ง 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 "
  }
]
}