hugo book
1.0.0
การออกแบบที่เรียบง่ายสะอาดตา
เป็นมิตรกับมือถือ
ปรับแต่งได้
ออกแบบมาเพื่อไม่รบกวนเค้าโครงอื่น
การกำหนดค่าเริ่มต้นเป็นศูนย์
ฮิวโก้ 0.43 หรือสูงกว่า
Hugo เวอร์ชันขยาย อ่านเพิ่มเติมที่นี่
ไปที่รูทเว็บไซต์ Hugo ของคุณแล้วรัน:
git submodule add https://github.com/alex-shpak/hugo-book themes/book
จากนั้นรัน Hugo (หรือตั้ง theme: book ในไฟล์กำหนดค่า)
hugo server --theme book
ตามค่าเริ่มต้น ธีมจะแสดงเพจจากส่วน content/docs เป็นเมนูในโครงสร้างแบบต้นไม้
คุณสามารถตั้ง title และ weight ด้านหน้าของหน้าเพื่อปรับลำดับและชื่อเรื่องในเมนูได้
คุณยังสามารถใช้ leaf Bundle และเนื้อหาของมัน index.md เป็นเมนูได้
เนื่องจากคุณมีโครงสร้างไฟล์นี้
├── content │ ├── docs │ │ ├── page-one.md │ │ └── page-two.md │ └── posts │ ├── post-one.md │ └── post-two.md
สร้างไฟล์ content/docs/menu/index.md ด้วยเนื้อหา
---headless: true---- [ตัวอย่างหนังสือ](/docs/) - [หน้าหนึ่ง](/docs/page-one) - [หน้าสอง](/docs/page-two)- [บล็อก](/posts)
และเปิดใช้งานโดยการตั้งค่า BookMenuBundle: /docs/menu ในการกำหนดค่าไซต์
เมนูตัวอย่าง
ตัวอย่างไฟล์ปรับแต่ง
มัดใบ
บล็อกแบบธรรมดารองรับ posts หัวข้อ
มีตัวเลือกการกำหนดค่าไม่กี่ตัวเลือกที่คุณสามารถเพิ่มลงในไฟล์ config.yml|json|toml
# (ไม่บังคับ) ตั้งค่านี้เป็นจริงหากคุณใช้ตัวอักษรพิมพ์ใหญ่ในชื่อไฟล์disablePathToLower: true# (ไม่บังคับ) ตั้งค่านี้เป็นจริงเพื่อเปิดใช้งานวันที่ 'แก้ไขล่าสุดโดย' และข้อมูล git author# ในประเภท 'doc' หน้าต่างๆ เปิดใช้งานGitInfo: true# (คำเตือน) ธีมนี้มีไว้สำหรับการใช้เอกสารประกอบ เนื่องจากมันไม่แสดงอนุกรมวิธาน # คุณสามารถซ่อนคำเตือนที่เกี่ยวข้องได้ด้วย config belowdisableKinds: ["taxonomy", "taxonomyTerm"]params: # (ไม่บังคับ ค่าเริ่มต้นเป็นจริง) แสดงหรือซ่อนสารบัญทั่วโลก # คุณยังสามารถระบุพารามิเตอร์นี้ต่อหน้าในส่วนหน้าได้ BookShowToC: จริง # (ไม่บังคับ ค่าเริ่มต้นไม่มี) ตั้งค่า Leaf Bundle ให้แสดงผลเป็นเมนูด้านข้าง # เมื่อไม่ได้ระบุโครงสร้างไฟล์และน้ำหนักจะถูกใช้ BookMenuBundle: /เมนู # (ทางเลือก เอกสารเริ่มต้น) ระบุส่วนของเนื้อหาที่จะแสดงผลเป็นเมนู # คุณยังสามารถตั้งค่าเป็น "*" เพื่อแสดงผลทุกส่วนในเมนู หมวดหนังสือ: เอกสาร # ค่านี้ซ้ำกับ $link-color สำหรับการไฮไลต์ลิงก์ที่ใช้งานอยู่ในโหมดบันเดิลเมนู # BookMenuBundleActiveLinkColor: #004ed0 # รวมสคริปต์ JS ในหน้าต่างๆ ปิดใช้งานตามค่าเริ่มต้น # - ให้เมนูด้านข้างอยู่ในตำแหน่งเลื่อนเดียวกันระหว่างการนำทาง BookEnableJS: จริง # กำหนดตำแหน่งแหล่งเก็บข้อมูลต้นทาง # ใช้สำหรับลิงก์ 'แก้ไขล่าสุด' และ 'แก้ไขหน้านี้' BookRepo: https://github.com/alex-shpak/hugo-book # เปิดใช้งานลิงก์ "แก้ไขหน้านี้" สำหรับประเภทหน้า 'doc' # ปิดการใช้งานโดยค่าเริ่มต้น ยกเลิกการแสดงความคิดเห็นเพื่อเปิดใช้งาน ต้องใช้พารามิเตอร์ 'BookRepo' # เส้นทางต้องชี้ไปที่ไดเรกทอรี 'เนื้อหา' ของ repo BookEditPath: แก้ไข/ต้นแบบ/ตัวอย่างไซต์/เนื้อหา
คุณสามารถระบุพารามิเตอร์เพิ่มเติมต่อหน้าในส่วนหน้าได้
---# ตั้งค่าประเภทเป็น 'docs' หากคุณต้องการแสดงหน้านอกส่วนที่กำหนดค่าหรือหากคุณแสดงส่วนอื่นที่ไม่ใช่ 'docs'type: docs# ตั้งค่าน้ำหนักหน้าเพื่อจัดเรียงรายการใหม่ในเมนูแผนผังไฟล์ (หาก BookMenuBundle not set)weight: 10# (ไม่บังคับ) ตั้งค่าให้ทำเครื่องหมายหน้าเป็นส่วนเรียบในเมนูแผนผังไฟล์ (หากไม่ได้ตั้งค่า BookMenuBundle) bookFlatSection: true# (ไม่บังคับ) ตั้งค่าให้ซ่อนสารบัญ แทนที่ค่าส่วนกลางbookShowToC: false---
มีบางส่วนว่างบางส่วนที่คุณสามารถแทนที่ได้ใน layouts/partials/
| บางส่วน | ตำแหน่ง |
|---|---|
layouts/partials/docs/inject/head.html | ก่อนปิดแท็ก <head> |
layouts/partials/docs/inject/body.html | ก่อนปิดแท็ก <body> |
layouts/partials/docs/inject/menu-before.html | ที่จุดเริ่มต้นของบล็อกเมนู <nav> |
layouts/partials/docs/inject/menu-after.html | ที่ส่วนท้ายของบล็อกเมนู <nav> |
ยินดีต้อนรับการมีส่วนร่วมและฉันจะตรวจสอบและพิจารณาคำขอดึง
เป้าหมายหลักคือ:
ทำให้มันง่าย
คงการกำหนดค่าเริ่มต้นให้น้อยที่สุด (หรือศูนย์)
หลีกเลี่ยงการรบกวนกับเค้าโครงที่ผู้ใช้กำหนด
อย่าลังเลที่จะเปิดปัญหาหากคุณไม่มีตัวเลือกการกำหนดค่าหรือการปรับแต่งบางอย่าง
เอ็มไอที
