just the docs

แค่เอกสาร

ธีม Jekyll ที่ทันสมัย ​​ปรับแต่งได้สูงและตอบสนองสำหรับเอกสารประกอบที่มีการค้นหาในตัว
โฮสต์ได้อย่างง่ายดายบนหน้า GitHub โดยมีการขึ้นต่อกันเพียงเล็กน้อย

ดูมันใช้งานจริง!

วิดีโอแนะนำฟีเจอร์ต่างๆ ของ Just the Docs

เพียง-the-docs-features-walkthrough.mp4

การติดตั้ง

ใช้เทมเพลต

เทมเพลต Just the Docs มอบวิธีที่ง่ายที่สุด รวดเร็วที่สุด และง่ายที่สุดในการสร้างเว็บไซต์ใหม่ที่ใช้ธีม Just the Docs หากต้องการเริ่มต้นสร้างไซต์ เพียงคลิก "ใช้เทมเพลต"!

หมายเหตุ: หากต้องการใช้ธีม คุณ ไม่ จำเป็นต้องโคลนหรือแยกที่เก็บ Just the Docs! คุณควรทำเช่นนั้นเฉพาะในกรณีที่คุณต้องการเรียกดูเอกสารธีมในเครื่อง สนับสนุนการพัฒนาธีม หรือพัฒนาธีมใหม่โดยใช้ Just the Docs

คุณสามารถตั้งค่าไซต์ที่สร้างโดยเทมเพลตให้เผยแพร่บน GitHub Pages ได้อย่างง่ายดาย ไฟล์เทมเพลต README จะอธิบายวิธีการดำเนินการดังกล่าว พร้อมด้วยรายละเอียดอื่นๆ

หากมีการติดตั้ง Jekyll บนคอมพิวเตอร์ของคุณ คุณสามารถสร้างและดูตัวอย่างไซต์ที่สร้างขึ้น ในเครื่องได้ ซึ่งช่วยให้คุณทดสอบการเปลี่ยนแปลงก่อนดำเนินการ และหลีกเลี่ยงการรอหน้า GitHub ¹ และคุณจะสามารถปรับใช้บิลด์ในเครื่องของคุณกับแพลตฟอร์มที่แตกต่างจาก GitHub Pages

โดยเฉพาะอย่างยิ่ง ไซต์ที่สร้างขึ้น:

• ใช้วิธีการแบบอิงอัญมณี เช่น ใช้ Gemfile และโหลดอัญมณีแบบ just-the-docs
• ใช้เวิร์กโฟลว์ GitHub Pages / Actions เพื่อสร้างและเผยแพร่ไซต์บน GitHub Pages

นอกจากนั้น คุณมีอิสระในการปรับแต่งไซต์ที่คุณสร้างด้วยเทมเพลตตามที่คุณต้องการ คุณสามารถเปลี่ยนเวอร์ชันของ just-the-docs และ Jekyll ที่ใช้ได้อย่างง่ายดาย รวมถึงการเพิ่มปลั๊กอินเพิ่มเติม

ใช้ RubyGems

หรือคุณสามารถติดตั้งธีมเป็น Ruby Gem ได้โดยไม่ต้องสร้างไซต์ใหม่

เพิ่มบรรทัดนี้ลงใน Gemfile ของไซต์ Jekyll ของคุณ:

 gem "just-the-docs"

และเพิ่มบรรทัดนี้ลงใน _config.yml ของไซต์ Jekyll ของคุณ:

 theme : just-the-docs

แล้วดำเนินการ:

 $ bundle

หรือติดตั้งด้วยตัวเองเป็น:

 $ gem install just-the-docs

หรือคุณสามารถเรียกใช้ภายใน Docker ในขณะที่พัฒนาไซต์ของคุณได้

 $ docker-compose up

การใช้งาน

ดูเอกสารประกอบสำหรับข้อมูลการใช้งาน

มีส่วนร่วม

รายงานข้อผิดพลาด ข้อเสนอคุณสมบัติใหม่ และคำขอดึงข้อมูลยินดีต้อนรับบน GitHub ที่ https://github.com/just-the-docs/just-the-docs โครงการนี้มีวัตถุประสงค์เพื่อเป็นพื้นที่ที่ปลอดภัยและเป็นมิตรสำหรับการทำงานร่วมกัน และผู้มีส่วนร่วมจะต้องปฏิบัติตามจรรยาบรรณของผู้ร่วมให้ข้อมูล

การส่งการเปลี่ยนแปลงรหัส:

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

หลักการออกแบบและพัฒนาหัวข้อนี้:

1. การพึ่งพาอาศัยกันน้อยที่สุด
2. ไม่จำเป็นต้องมีสคริปต์สร้าง
3. ประสบการณ์มือถือระดับเฟิร์สคลาส
4. ทำให้เนื้อหามีความโดดเด่น

การพัฒนา

หากต้องการตั้งค่าสภาพแวดล้อมของคุณเพื่อพัฒนาธีมนี้: แยก repo นี้ รัน bundle install จากไดเร็กทอรีราก

รวมการกำหนดค่า devcontainer ที่ทันสมัยสำหรับ VSCode แล้ว

ธีมของคุณได้รับการตั้งค่าเหมือนกับไซต์ Jekyll ทั่วไป! หากต้องการทดสอบธีมของคุณ ให้รัน bundle exec jekyll serve และเปิดเบราว์เซอร์ของคุณที่ http://localhost:4000 นี่เป็นการเริ่มเซิร์ฟเวอร์ Jekyll โดยใช้ธีมของคุณ เพิ่มหน้า เอกสาร ข้อมูล ฯลฯ เหมือนปกติเพื่อทดสอบเนื้อหาของธีมของคุณ เมื่อคุณทำการแก้ไขธีมและเนื้อหาของคุณ เว็บไซต์ของคุณจะถูกสร้างขึ้นใหม่และคุณควรเห็นการเปลี่ยนแปลงในเบราว์เซอร์หลังจากการรีเฟรช เช่นเดียวกับปกติ

เมื่อธีมนี้เปิดตัว เฉพาะไฟล์ใน _layouts , _includes และ _sass ที่ติดตามด้วย Git เท่านั้นที่จะรวมอยู่ในเจม

ใบอนุญาต

ธีมนี้พร้อมใช้งานในรูปแบบโอเพ่นซอร์สภายใต้เงื่อนไขของใบอนุญาต MIT

เชิงอรรถ

1. อาจใช้เวลาถึง 10 นาทีในการเผยแพร่การเปลี่ยนแปลงในไซต์ของคุณหลังจากที่คุณพุชการเปลี่ยนแปลงไปยัง GitHub