ข้ามไปยังเนื้อหาหลัก
ลด 50% ทุกแพลน เวลาจำกัด เริ่มต้นที่ $2.48/mo
MkDocs

MkDocs

MkDocs เปลี่ยนโฟลเดอร์ที่มีไฟล์ Markdown ให้เป็นเว็บไซต์เอกสารด้วยไฟล์คอนฟิก YAML เพียงไฟล์เดียว มาพร้อม dev server ที่รีโหลดสด และสร้าง HTML แบบสแตติกล้วนที่นำไปโฮสต์ที่ไหนก็ได้ ใช้สัญญาอนุญาต BSD-2-Clause และมีดาว GitHub มากกว่า 22,300 ดวง

ภาพรวม

22.4k

GitHub stars

1

การดูหน้า

สัญญาอนุญาต BSD-2-Clause เวอร์ชัน Latest OS Ubuntu Server 24.04 LTS Min RAM 1 GB IP IPV4,IPV6

การเข้าถึง

  • เปิด: http://SERVER_IP

แก้ไขและเผยแพร่เนื้อหา

1. เพิ่มหรือแก้ไขไฟล์ Markdown: /opt/mkdocs/docs

2. หากคุณเพิ่มหรือเปลี่ยนชื่อหน้า ให้อัปเดต /opt/mkdocs/mkdocs.yml for navigation.

3. บิลด์เว็บไซต์ใหม่:

/opt/mkdocs/venv/bin/mkdocs build --clean \
  --config-file /opt/mkdocs/mkdocs.yml \
  --site-dir /opt/mkdocs/site

Nginx ให้บริการไฟล์ที่สร้างขึ้นจาก: /opt/mkdocs/site

ไม่จำเป็นต้องรีสตาร์ต Nginx หลังบิลด์ใหม่

Path ที่สำคัญ

  • โปรเจกต์: /opt/mkdocs
  • เนื้อหา: /opt/mkdocs/docs
  • การตั้งค่า: /opt/mkdocs/mkdocs.yml
  • ผลลัพธ์การบิลด์: /opt/mkdocs/site
  • สภาพแวดล้อมเสมือนของ Python: /opt/mkdocs/venv
  • ไฟล์ปฏิบัติการของ MkDocs: /opt/mkdocs/venv/bin/mkdocs
  • การกำหนดค่า Nginx: /etc/nginx/sites-available/mkdocs.conf

โดเมนและ HTTPS

1. ชี้โดเมนของคุณไปที่ที่อยู่ IP ของเซิร์ฟเวอร์

2. แก้ไขการกำหนดค่า Nginx และแทนที่ server_name _; ด้วยโดเมนของคุณ (เช่น server_name <YOUR_DOMAIN>;):

vim /etc/nginx/sites-available/mkdocs.conf

3. ทดสอบการกำหนดค่า:

nginx -t

4. ติดตั้ง Certbot:

apt install -y certbot python3-certbot-nginx

5. สร้างใบรับรอง Let's Encrypt:

certbot --nginx --non-interactive --agree-tos --email <YOUR_EMAIL> -d <YOUR_DOMAIN>

6. รีโหลด Nginx:

systemctl reload nginx

7. อัปเดต URL ของเว็บไซต์ MkDocs: แทนที่ site_url: 'http://<SERVER_IP>/' ด้วย site_url: 'https://<YOUR_DOMAIN>/' in /opt/mkdocs/mkdocs.yml.

8. บิลด์เว็บไซต์ใหม่:

/opt/mkdocs/venv/bin/mkdocs build --clean \
  --config-file /opt/mkdocs/mkdocs.yml \
  --site-dir /opt/mkdocs/site

9. เปิด browser และไปที่: https://<YOUR_DOMAIN>

หมายเหตุ

  • การแก้ไข Markdown ต้องบิลด์ใหม่ก่อนจึงจะปรากฏบนเว็บไซต์สาธารณะ
  • Nginx serves the generated files from /opt/mkdocs/site.
  • เปลี่ยน mkdocs.yml และการกำหนดค่าโปรเจกต์ตามที่คุณต้องการ

เพิ่มเติมในเครื่องมือพัฒนา

แอปที่เกี่ยวข้อง

ติดตั้ง MkDocs ได้เลยตอนนี้ เริ่มต้น $2.48/เดือน