cortexjs.io ดาวน์โหลด - cortexjs.io ซอร์สโค้ดดาวน์โหลดดาวน์โหลด

cortexjs.io

ส่วนประกอบของบุคคลที่สาม

1.0.0

ดาวน์โหลด

repo นี้มีไฟล์ต้นฉบับสำหรับเว็บไซต์ "cortexjs.io"

tl; dr

ครั้งแรกหลังจากโคลนนิ่งโครงการหรือหลังจากทำการเปลี่ยนแปลงแหล่งข้อมูลบางอย่าง

git submodule init

git submodule update

# Setup, make a dev build and start a server
npm start

เพื่ออัปเดตเอกสารหลังจากรีลีสใหม่

 # Pick-up changes in the dependent modules
npm run update

# Generate .md files for API and launch local server
npm start

ไปยังขั้นตอนและปรับใช้การอัปเดต

npm run stage
# Make a clean production build.
# Output goes inside submodules/cortex-js.github.io

npm run restart
# Validate that everything works well in the browser then...

npm run deploy
# submodules/cortex-js.github.io (a git submodule) gets pushed to cortex-js.github.io

สถาปัตยกรรม

ไซต์ถูกเผยแพร่โดยใช้หน้า GitHub ประโยชน์หลักของการใช้หน้า GH คือการรวมเวิร์กโฟลว์ (Pubshing to GH ทริกเกอร์การอัปเดตอัตโนมัติของเว็บไซต์ที่ให้บริการ)

เนื้อหาของไซต์นั้นถูกเขียนขึ้นเป็นไฟล์ Markdown เป็นหลักประมวลผลด้วย eleventy เพื่อเปลี่ยนเป็น HTML/CSS

การกำหนดค่า eleventy สำคัญอย่างมากคือในไฟล์ config/eleventy.js รวมถึงคำจำกัดความของ markdown ที่จะใช้

เอ็นจิ้น Markdown เป็น markdown-it ซึ่งใช้ Commonmark

ปลั๊กอิน mardown-it-attrs ช่วยให้สไตล์ของย่อหน้าเช่น

นี่คือการแจ้งเตือน {.notice-info}

ปลั๊กอิน markdown-it-deflist รองรับรายการนิยามสไตล์ PANDC:

 Term 1
:   Definition 1
:   Second definition

ผลลัพธ์อยู่ในไดเรกทอรี submodules/cortex-js.github.io ไดเรกทอรีนั้นเป็น submodule git ที่เชื่อมโยงกับ cortex-js.github.io repo repo นั้นเป็นหนึ่งที่เผยแพร่โดย GH Pages (สำหรับองค์กรสามารถเผยแพร่ได้เฉพาะ repo ทั้งหมดสำหรับโครงการเนื้อหาสามารถมีอยู่ในไดเรกทอรี A /docs )

ดูเพิ่มเติมที่ submodules

cortex-js.github.io repo ต้องมีไฟล์เพิ่มเติมสองไฟล์:

.nojekyll ซึ่งระบุว่า GitHub ว่าไม่ควรประมวลผลเนื้อหาของ repo นี้กับ Jekyll (เนื่องจากนี่เป็นเอาท์พุทจาก Jekyll แล้ว)
CNAME ด้วยเนื้อหาของ cortexjs.io

ไฟล์เหล่านี้ถูกสร้างขึ้นเมื่อเรียกใช้ npm run stage

ใช้แท็บการตั้งค่าใน cortex-js.github.io repo เพื่อระบุการใช้โดเมนที่กำหนดเอง

นอกจากนี้รายการ DNS สำหรับ cortexjs.io ต้องมีสิ่งต่อไปนี้:

บันทึก cname ที่ชี้ไปที่ www.cortex-js.io ไปยัง cortex-js.io
สี่บันทึกที่ชี้ไปที่
- 185.199.108.153
- 185.199.109.153
- 185.199.110.153
- 185.199.111.153

เนื้อหา

คำสั่ง npm run build สร้างเอกสารสำหรับ APIs จากไฟล์ typeScript .d.ts ลงใน build/ Directory

กระบวนการสร้างใช้เครื่องมือ typedoc เพื่อแยกวิเคราะห์ไฟล์ส่วนหัว API และส่งออกไฟล์ json ใน build/ Directory

หมายเหตุ: ในการดีบักตัวแปลงให้ใช้ตัวดีบัก VSCODE เลือก DEBUG> เริ่มการดีบักเพื่อเริ่มการดีบักเซสชันที่ถูกต้องใน VSCODE

สคริปต์ build-guides จากนั้นจะแปลงไฟล์ json เป็น markdown ในไดเรกทอรี ./src/build build ซึ่งสามารถประมวลผลได้โดย Elevthing ด้วยการเริ่ม npm run build หรือ npm start

ข้อมูลการจัดแต่งทรงผม CSS ถูกกำหนดไว้ใน src/_sass/

เอกสาร API ควรทำตามคู่มือสไตล์ Google เอกสาร (https://developers.google.com/style/api-reference-comments) และ https://developers.google.com/style

นอกจากนี้รหัส TypeScript ควรทำตามคู่มือ Google Style: https://google.github.io/styleguide/jsguide.html#naming