teedoc

teedoc

中文 | ภาษาอังกฤษ

เว็บไซต์อย่างเป็นทางการ: teedoc.neucrack.com หรือ teedoc.github.io

การสาธิตเพิ่มเติม: ดูที่นี่หรือที่นี่

เอกสารสร้างเครื่องมือจาก Markdown และ Jupyter Notebook เป็น HTML

teedoc สามารถใช้ในสถานการณ์ต่อไปนี้:

• สร้างเว็บไซต์เอกสารและเป็นการดีที่สุดที่จะสนับสนุนเอกสารหลายฉบับและหน้ากำหนดเอง
• เอกสารขององค์กรหรือ บริษัท ต่างๆแพร่กระจายในโดเมนที่แตกต่างกันต้องการรวมเข้ากับเว็บไซต์เดียว (โดเมน)
• สร้างเว็บไซต์ WiKi
• สร้างฐานความรู้ส่วนตัวหรือองค์กร
• สร้างเว็บไซต์ส่วนบุคคลหรือองค์กร

คุณสมบัติ

• ใช้งานง่ายข้ามแพลตฟอร์มต้องการ Python3 เท่านั้น
• ง่ายต่อการปรับใช้ให้คัดลอกไฟล์ HTML ที่สร้างขึ้นไปยังเซิร์ฟเวอร์ของคุณหรือโฮสต์อื่น ๆ เท่านั้น
• ง่ายต่อการเขียนการสนับสนุน Markdown
• การสนับสนุนสมุดบันทึก Jupyter
• สนับสนุนเอกสารหลายฉบับ
• ปลั๊กอินรองรับ
• การสนับสนุนชุดรูปแบบหลายชุด (สนับสนุนโดยปลั๊กอิน)
• ควบคุมสไตล์ที่แม่นยำในหน้าผ่าน CSS (นำไปใช้โดยการปรับแต่ง ID และคลาสของแต่ละหน้า)
• การสนับสนุนไดเรกทอรีหลายระดับ
• การสนับสนุนหลายภาษา (การแปลด้วยตนเอง) (สากล/i18n)
• การสนับสนุนหลายภาษา (ปลั๊กอินแปล)
• สนับสนุนเวอร์ชันหลายรุ่น
• การสนับสนุนการค้นหา
• SEO เป็นมิตร
• การเปลี่ยนแปลงไฟล์ตัวอย่างแบบเรียลไทม์
• การสร้างแบบขนานความเร็วในการสร้างที่เร็วขึ้น
• การสนับสนุนบล็อก
• การสนับสนุนเทมเพลตเค้าโครง Jinja2 HTML

เริ่มต้นใช้งาน

เยี่ยมชมเว็บไซต์อย่างเป็นทางการ: teedoc.github.io หรือ teedoc.neucrack.com

สร้างเว็บไซต์ของคุณในหน้า GitHub ในไม่กี่นาที

ดูเทมเพลต repo

quik start

• ติดตั้ง Python3

บน Windows หรือ macOS ดาวน์โหลดจาก python.org

บน Linux , Ubuntu ตัวอย่างเช่น:

 sudo apt install python3 python3-pip

• ติดตั้ง teedoc

คำสั่งนี้จะ ติดตั้งโปรแกรม teedoc

 pip3 install -U teedoc

• เริ่มต้นเอกสาร

 mkdir my_site
cd my_site
teedoc init

หรือ

 teedoc -d my_site init

เลือกเทมเพลตขั้นต่ำในโปรโมชั่น

• ติดตั้งปลั๊กอิน

คำสั่งนี้จะ ติดตั้งปลั๊กอิน ที่ใช้โดย DOC (ตั้งค่าใน site_config.json )

 cd my_site
teedoc install

• สร้างหรือให้บริการ

 teedoc serve

จากนั้นเยี่ยมชม http://127.0.0.1:2333 ในเบราว์เซอร์

หากคุณต้องการสร้าง HTMLs เท่านั้น:

 teedoc build