ตั้งค่าที่เก็บข้อมูล

ตั้งค่าที่เก็บ (repository) สมมติว่าคุณได้ ทำการเชื่อมต่อเสร็จเรียบร้อยแล้ว https //docs archbee com/github#jjpev ขั้นตอนถัดไปคือการตั้งค่าที่เก็บ (repository) คุณต้องตั้งค่าและกำหนดค่า repo ของคุณให้สำเร็จ เพื่อให้ archbee สามารถดึงเนื้อหาที่อยู่ในนั้นและจัดการให้เรียบร้อยในระบบของเรา คุณสามารถ fork repository นี้ https //github com/dragosbulugean/slate ได้ หากระบบพบไฟล์ archbee yaml ใน root ของ repository ของคุณหรือโฟลเดอร์อื่นๆ (หากคุณใช้ multipath) เช่นนี้ ไฟล์ yaml https //github com/dragosbulugean/slate/blob/master/ archbee yaml ระบบจะใช้ไฟล์นั้นเพื่อจัดระเบียบเนื้อหา โปรดให้ความสนใจเป็นพิเศษกับไฟล์ yaml https //github com/dragosbulugean/slate/blob/master/ archbee yaml ที่นี่ หากคุณต้องการกำหนดค่าโฟลเดอร์ที่เนื้อหา markdown ถูก render มาจาก (หรือโครงสร้างเอกสารแบบ summary tree) สร้างไฟล์ yaml สร้างไฟล์ archbee yaml พร้อมโครงสร้างตัวแปรดังต่อไปนี้ คุณต้องวางไฟล์ไว้ในโฟลเดอร์รูทของที่เก็บ (repository) ของคุณ ตรวจสอบให้แน่ใจว่าไฟล์ยังคงอยู่ที่นั่น เนื่องจากเป็นเส้นทางเริ่มต้นสำหรับโฟลเดอร์อื่น ๆ – หากคุณมีหลายโฟลเดอร์ คุณต้องคัดลอกไฟล์ไปยังโฟลเดอร์เหล่านั้นด้วย ถามว่าทำอย่างไร? ดูวิธี ซิงค์หลายโฟลเดอร์ https //docs archbee com/sync multiple github folders ได้เลย คีย์เหล่านี้หมายความว่าอย่างไร? root /docs คุณสมบัตินี้กำหนดตำแหน่งไดเรกทอรีที่มีเอกสาร (สามารถแทนที่ด้วย docspath /docs ) structure summary summary md สร้างโครงสร้างเอกสารใหม่ในแถบนำทางด้านซ้ายใน archbee หากไม่มี เราจะถือว่าโฟลเดอร์เป็นหมวดหมู่และจำลองโครงสร้างไฟล์ภายใน assets assets โฟลเดอร์ assets จะสัมพันธ์กับ docspath archbee จะอัปโหลดไฟล์ทั้งหมดที่พบในโฟลเดอร์นั้น (ไฟล์โค้ดและรูปภาพ) shadowdocs คุณต้องกำหนดไฟล์/โฟลเดอร์โค้ดที่จะรวมเป็น shadow docs publishspace ค่า boolean ตั้งเป็น true หากคุณต้องการเผยแพร่พื้นที่ไปยัง production portal หลังจากแต่ละ commit ตัวอย่างของไฟล์ archbee yaml archbee yaml root doc api structure summary summary md assets assets publishspace true headerincludes | \<script> document getelementbyid("demo") innerhtml = "hello javascript!"; \</script> ตัวอย่างของ archbee json ไฟล์คอนฟิก archbee json { "root" "docfolderwithsummary", "structure" { "summary" "summary md", "assets" " archbee/assets" }, "customjs" "", "customcss" " \n { font family \\"comic sans ms\\", cursive, sans serif; }", "footertemplate" "", "headerincludes" "" } สร้างไฟล์ summary md เรายังแนะนำให้คุณสร้างไฟล์ summary md ไฟล์นี้จะช่วยให้ summary md สร้างโครงสร้างเอกสารในแผงนำทางด้านซ้ายของ archbee และช่วยให้คุณจัดระเบียบเนื้อหาได้อย่างเป็นระเบียบ ดูตัวอย่างไฟล์ summary md ด้านล่าง summary md \[introduction]\(1 md) \## table of contents \ \[init]\(init md) \ \[configure app]\(config md) \ \[config database]\(config database md) \ \[config redis]\(config redis md) \ \[config elastic search]\(config es md) \ \[swagger]\(swagger v2 json) ใช้ไวยากรณ์ markdown กับ github บล็อกเนื้อหาบางประเภทสามารถเรนเดอร์ได้หากคุณใช้ไวยากรณ์เฉพาะ ตรวจสอบ ทางลัด markdown ของโปรแกรมแก้ไข docid 1mgrozhjknd15rsrjhvfx เพื่อใช้คีย์ลัดเหล่านี้ เพิ่มที่เก็บหลายรายการ ทำตามขั้นตอนง่ายๆ เหล่านี้เพื่อเพิ่มที่เก็บ (repositories) หลายรายการและซิงก์กับ archbee ไปที่บัญชี github https //github com/settings/installations ที่เชื่อมต่อกับ archbee จากนั้นไปที่หน้า settings บนแถบด้านซ้าย ให้มองหาเมนู applications คลิกปุ่ม configure และเมื่อหน้าใหม่เปิดขึ้น ให้กำหนดสิทธิ์เข้าถึงดังนี้ ที่เก็บทั้งหมด (ซึ่งหมายความว่าคุณสามารถเลือก repo ใดก็ได้จากบัญชี archbee ของคุณ) เลือกเฉพาะที่เก็บบางรายการ (เลือกที่เก็บใหม่ที่คุณต้องการซิงก์กับ archbee) คลิก save กลับไปที่บัญชี archbee ของคุณ จากแผงนำทางด้านซ้าย ให้สร้าง space ใหม่ > เลือก write in github และเลือกที่เก็บที่คุณเพิ่งเพิ่มเข้ามา นำเข้าไฟล์ open api คุณสามารถนำเข้าไฟล์ open api ผ่าน github ได้ ฟีเจอร์นี้ทำงานเหมือนกับฟีเจอร์ การนำเข้า openapi / swagger docid\ rcamfvneqblhziqblytkd รวมถึงการตั้งค่าต่างๆ มีสิ่งสำคัญ 2 อย่างที่ต้องตั้งค่า เส้นทางไปยังไฟล์ open api ( json, yml, yaml) ที่ต้องเขียนไว้ใน summary md ไฟล์คอนฟิก การตั้งค่าที่ต้องเขียนในไฟล์คอนฟิกหลักภายใต้ doctreeoptions archbee yaml docspath /myapp docs structure summary toc md assets assets doctreeoptions openapitryit false showdownloadopenapifile true shouldcreateschemacategory true shouldcreateintro true openapilanguageexamples \ value python label py \ value javascript label js footertemplate "" headerincludes ""