เอกสารลูกหนู

สารบัญ

• คำอธิบาย

• การติดตั้ง

• ความต้องการ

• การใช้งาน

• มีส่วนร่วม

• ใบอนุญาต

คำอธิบาย

bicep-docs เป็นเครื่องมือบรรทัดคำสั่งที่สร้างเอกสารสำหรับเทมเพลต Bicep

การติดตั้ง

โฮมบรูว์

 แตะชง Christosgalano/christosgalano
ชงติดตั้ง bicep-docs

ไป

 ไปติดตั้ง github.com/christosgalano/bicep-docs/cmd/bicep-docs@latest

ไบนารี่

ดาวน์โหลดไบนารีล่าสุดจากหน้าเผยแพร่

ความต้องการ

หากต้องการเรียกใช้ bicep-docs จะต้องติดตั้ง Azure CLI หรือ Bicep CLI

คลีไอ	เวอร์ชันขั้นต่ำที่ต้องการ
สีฟ้า	2.64.0
ไบเซป	0.29.0

การใช้งาน

bicep-docs เป็นเครื่องมือบรรทัดคำสั่งที่สร้างเอกสารสำหรับเทมเพลต Bicep

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

สามารถใช้เพื่อสร้างและอัปเดตเอกสารสำหรับเทมเพลต Bicep ของคุณโดยอัตโนมัติ

หากอินพุตเป็นไดเร็กทอรี ดังนั้นสำหรับแต่ละ main.bicep มันจะสร้าง README.md ในไดเร็กทอรีเดียวกัน สิ่งนี้เกิดขึ้นแบบวนซ้ำสำหรับไดเร็กทอรีย่อยทั้งหมด

หากอินพุตเป็นไฟล์ Bicep เอาต์พุตจะต้องเป็นไฟล์ มิฉะนั้นข้อผิดพลาดจะถูกส่งกลับ

ค่าดีฟอลต์สำหรับเอาต์พุตคือ README.md ซึ่งสัมพันธ์กับไดเร็กทอรีที่คำสั่งถูกดำเนินการ

ข้อควรระวัง: หากมีไฟล์ Markdown อยู่แล้ว ไฟล์นั้นจะถูก เขียนทับ

ข้อโต้แย้ง

เกี่ยวกับข้อโต้แย้ง --include-sections และ --exclude-sections ส่วนที่มีอยู่คือ: description , usage , modules , resources , parameters , udfs , uddts , variables , outputs

ส่วนเริ่มต้นที่เรียงลำดับคือ description,usage,modules,resources,parameters,udfs,uddts,variables,outputs อินพุตเริ่มต้นสำหรับ --exclude-sections คือ '' สิ่งนี้ทำให้มั่นใจได้ถึงความเข้ากันได้แบบย้อนหลังกับเวอร์ชันก่อนหน้า

ลำดับของส่วนต่างๆ จะเคารพเมื่อรวมส่วนต่างๆ เข้าด้วยกัน

เมื่อแยกส่วน ผลลัพธ์จะเป็นส่วนเริ่มต้นลบส่วนที่ถูกแยกออก (เช่น --exclude-sections description,usage จะรวม modules,resources,parameters,udfs,uddts,variables,outputs ตามลำดับนั้น)

ไม่สามารถระบุอาร์กิวเมนต์ทั้งสองพร้อมกันได้ เว้นแต่อาร์กิวเมนต์ --include-sections จะเหมือนกับส่วนเริ่มต้น (เช่น --include-sections description,usage,modules,resources,parameters,udfs,uddts,variables,outputs ) .

ตัวอย่างการใช้งาน

แยกไฟล์ Bicep และสร้างไฟล์ Markdown:

 bicep-docs --input main.bicep --output readme.md

แยกไฟล์ Bicep และสร้างไฟล์ README.md ในไดเรกทอรีเดียวกัน:

 bicep-docs -i main.bicep

แยกวิเคราะห์ไดเร็กทอรีและสร้างไฟล์ README.md สำหรับแต่ละไฟล์ main.bicep พร้อมเอาต์พุตแบบละเอียด:

 bicep-docs -i ./bicep -V

แยกไฟล์ Bicep และสร้าง README.md ยกเว้นส่วนที่ผู้ใช้กำหนด:

 bicep-docs --input main.bicep --exclude-sections udfs,uddts

แยกไฟล์ Bicep และสร้าง README.md รวมถึงเฉพาะทรัพยากรและโมดูลตามลำดับ:

 bicep-docs --- อินพุต main.bicep -- รวมทรัพยากรส่วนโมดูล

สามารถดูตัวอย่างเพิ่มเติมได้ที่นี่

รูปแบบเอกสาร

เอกสารมีรูปแบบดังต่อไปนี้:

 # ชื่อโมดูล | ชื่อไฟล์## คำอธิบาย...## การใช้งาน...## โมดูลที่เสถียรของโมดูล## ทรัพยากรของทรัพยากร## พารามิเตอร์ที่เสถียรของพารามิเตอร์## ตารางประเภทข้อมูลที่ผู้ใช้กำหนด (UDDT) ของ UDDTs## ตารางฟังก์ชันที่ผู้ใช้กำหนด (UDF) ของ UDFS## ตัวแปรของตัวแปร## เอาต์พุตของเอาต์พุต

โครงสร้างโฟลเดอร์

เครื่องมือนี้มีประโยชน์อย่างยิ่งหากคุณติดตามโครงสร้างนี้สำหรับโครงการ Bicep ของคุณ:

.
├── bicep
│   │
│   ├── modules
│   │   ├── compute
│   │   │   ├── main.bicep
│   │   │   └── README.md
│   │   └── ...
│   │
│   ├── environments
│   │   ├── development
│   │   │   ├── main.bicep
│   │   │   ├── main.bicepparam
│   │   │   └── README.md
│   │   └── ...

มีส่วนร่วม

ข้อมูลเกี่ยวกับการมีส่วนร่วมในโครงการนี้สามารถพบได้ที่นี่

ใบอนุญาต

โครงการนี้ได้รับอนุญาตภายใต้ใบอนุญาต MIT