โครงสร้างที่เก็บตัวอย่างแบบบล็อก

ที่เก็บตัวอย่างแบบบล็อกประกอบด้วยหมวดหมู่โปรเจ็กต์ที่แตกต่างกัน 2-3 หมวดหมู่ หน้านี้มีไว้เพื่อช่วยให้คุณเข้าใจว่าหมวดหมู่ต่างๆ ทำงานอยู่ที่ใด และแต่ละโปรเจ็กต์ในหมวดหมู่อาจประกอบด้วยอะไรบ้าง

Codelab

Codelab เป็นบทแนะนำแบบอินเทอร์แอกทีฟที่เขียนด้วยไวยากรณ์มาร์กดาวน์ และเผยแพร่ที่ blocklycodelabs.dev โดย Codelab จะใช้การผสมผสานระหว่างภาษาธรรมชาติ ตัวอย่างโค้ด และภาพหน้าจอ เพื่อสร้างประสบการณ์บทแนะนำที่น่าสนใจยิ่งขึ้น ผู้ใช้เป้าหมายจะติดตามและเรียกใช้โค้ด ขณะอ่าน

ไดเรกทอรี Codelab มีเทมเพลตและ 1 โฟลเดอร์ต่อ Codelab แต่ละโฟลเดอร์ของ Codelab จะมีไฟล์มาร์กดาวน์และเนื้อหาทั้งหมด (png, GIF เป็นต้น) สำหรับ Codelab

ตัวอย่าง

ตัวอย่างเช่น โปรเจ็กต์ตัวอย่างแบบจบในตอนซึ่งสาธิตเทคนิคในการรวมและขยายไลบรารี Blockly ซึ่งมักจะประกอบด้วยหน้าเว็บสาธิตและ โค้ดสนับสนุนบางส่วน ขณะที่ Codelab จะแนะนำการสร้างสิ่งต่างๆ ทีละขั้นตอน แต่ตัวอย่างจะแสดงผลิตภัณฑ์ที่เสร็จแล้ว และให้คุณสำรวจผลิตภัณฑ์ได้ด้วยตัวเอง

โค้ดตัวอย่างควรได้รับการแสดงความคิดเห็นที่เหมาะสมมากที่สุดเพื่อให้คัดลอกได้ง่าย ผู้ใช้เป้าหมายอาจอ่านโค้ด ใช้งานในเครื่อง หรือคัดลอกข้อมูลโค้ด

ไดเรกทอรีตัวอย่างมี 1 โฟลเดอร์ต่อตัวอย่าง ตัวอย่างแต่ละรายการทำงานได้ด้วย npm install && npm run start และมีไฟล์ README.md ที่มีบริบทหรือวิธีการเพิ่มเติม

ปลั๊กอิน

ปลั๊กอินเป็นส่วนของโค้ดในตัวที่เพิ่มฟังก์ชันให้กับ Blockly ปลั๊กอินสามารถเพิ่มช่อง กำหนดธีม สร้างโหมดแสดงภาพ และอื่นๆ อีกมากมาย ผู้ใช้เป้าหมายคือนักพัฒนาซอฟต์แวร์จะค้นหาและใช้ปลั๊กอินผ่าน npm ปลั๊กอินที่กำหนดไว้ในที่เก็บนี้เป็นปลั๊กอินของบุคคลที่หนึ่ง ซึ่งหมายความว่าทีม Blockly สนับสนุนปลั๊กอินดังกล่าว

ไดเรกทอรีปลั๊กอินมี 1 โฟลเดอร์ต่อปลั๊กอิน ปลั๊กอินแต่ละรายการมีไดเรกทอรี src ซึ่งมีโค้ด และไดเรกทอรี test ที่มีหน้าสาธิตอยู่ นอกจากนี้ยังมีไฟล์ README.md ซึ่งให้ข้อมูลแก่นักพัฒนาซอฟต์แวร์เกี่ยวกับการทำงานของปลั๊กอินและวิธีใช้

หน้า GitHub

ตัวอย่างบล็อกมีหน้าเว็บที่มีปลั๊กอินและเดโมจำนวนมากในสภาพแวดล้อมแบบสนามเด็กเล่น หน้านี้โฮสต์อยู่ในหน้า GitHub และโค้ดของเว็บไซต์นี้อยู่ในไดเรกทอรี gh-pages ของตัวอย่างบล็อก ไดเรกทอรีนี้มีเทมเพลตสำหรับหน้าต่างๆ ในเว็บไซต์ เนื้อหาจริงของเว็บไซต์จะสร้างขึ้นโดยใช้เทมเพลตและข้อมูลเมตาเหล่านี้จากปลั๊กอินหรือตัวอย่างที่โฮสต์แต่ละรายการ