Thai Maintaining the Wiki

การดูแล Wiki

GitHub wikis เป็นที่เก็บ Git แยกต่างหาก GitHub Command Line Interface (gh) สามารถยืนยันตัวตน Git, เปิดหรือใช้งาน wiki และให้บริบทของที่เก็บได้ แต่ปัจจุบันยังไม่มีคำสั่งในตัวสำหรับสร้างหรือแก้ไขหน้าของ wiki

การตั้งค่าครั้งแรก

หน้าหน้าแรกต้องมีอยู่ก่อนที่ GitHub จะเผยแพร่ที่เก็บ wiki ให้สามารถโคลนได้ Wiki นี้ได้ถูกเริ่มต้นแล้ว ดังนั้นผู้ดูแลสามารถใช้เวิร์กโฟลว์ในเครื่องได้โดยตรง

ยืนยันตัวตนและตั้งค่าการจัดการ credential ของ Git:

gh auth login
gh auth setup-git

โคลนที่เก็บ wiki:

git clone https://github.com/Appshines/Voice2Win.wiki.git
Set-Location Voice2Win.wiki

แก้ไขและเผยแพร่

แต่ละไฟล์ Markdown เป็นหนึ่งหน้า ชื่อไฟล์จะกลายเป็นที่อยู่ของหน้า; ตัวอย่างเช่น Getting-Started.md ถูกเผยแพร่เป็น Getting-Started _Sidebar.md ควบคุมแถบนำทางด้านข้าง

หลังจากแก้ไข:

git add --all
git commit -m "Update Voice2Win user guide"
git push

เฉพาะการเปลี่ยนแปลงที่ผลักไปยังสาขาเริ่มต้นของที่เก็บ wiki เท่านั้นที่จะปรากฏต่อผู้อ่าน

คำสั่ง GitHub CLI ที่เป็นประโยชน์

เปิด wiki:

gh browse --wiki --repo Appshines/Voice2Win

ตรวจสอบว่าฟีเจอร์นี้เปิดใช้งานแล้วหรือไม่:

gh repo view Appshines/Voice2Win --json hasWikiEnabled

เปิดใช้งานถ้าจำเป็น:

gh repo edit Appshines/Voice2Win --enable-wiki

ข้อกำหนดเนื้อหา

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

คำแนะนำอย่างเป็นทางการของ GitHub: การเพิ่มหรือแก้ไขหน้าวิกิ