Docusaurus: เครื่องมือที่ยอดเยี่ยมสำหรับการจัดทำเอกสารโครงการ

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

มีแอปพลิเคชั่นที่ค่อนข้างดีที่ช่วยให้เราสามารถจัดทำเอกสารโครงการของเราได้ด้วยวิธีง่ายๆบางส่วนมักจะเสนอมากกว่าสิ่งที่เราต้องการจริงๆและอื่น ๆ ต้องการการติดตั้งที่ซับซ้อน เครื่องมือในการจัดทำเอกสารโครงการ ที่สอดคล้องและใช้งานง่ายและติดตั้งคือ Docusaurus

Docusaurus คืออะไร?

โดคูซอรัส เป็นโครงการสำหรับ สร้างใช้งานและบำรุงรักษาเอกสารเว็บเครื่องมือโอเพนซอร์สอนุญาตให้ใช้ภาษา Markdown ในการเขียนเอกสารที่จะเผยแพร่ในภายหลังเป็นเว็บไซต์ html ในทำนองเดียวกันเครื่องมือนี้ช่วยให้เราสามารถขยายและปรับแต่งการออกแบบเว็บไซต์เอกสารของเราด้วยการใช้ React

โดยทั่วไปแล้วเครื่องมือโอเพนซอร์สที่พัฒนาโดยทีมเขียนโปรแกรม Facebook ช่วยให้เราสามารถสร้างเว็บไซต์ที่สวยงามและสว่างได้อย่างง่ายดายซึ่งเราสามารถแสดงเอกสารของโครงการใด ๆ ได้อย่างเหมาะสม

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

การใช้งาน Docusaurus อย่างง่าย ๆ สามารถดูได้ใน gif ต่อไปนี้ที่เผยแพร่โดยนักพัฒนา

จะติดตั้ง Docusaurus ได้อย่างไร?

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

ในการเริ่มเพลิดเพลินกับ Docusaurus บน Github เพียงทำตามขั้นตอนที่ระบุโดยทีมพัฒนาและที่เรากล่าวถึงด้านล่าง:

1. ไปที่รูทของไดเร็กทอรีที่เก็บ GitHub ของคุณซึ่งคุณจะสร้างเอกสารและรันคำสั่งต่อไปนี้:
2. yarn global add docusaurus-init or npm install --global docusaurus-init
3. docusaurus-init

ผลลัพธ์สุดท้ายจะเป็นการสร้างไฟล์และโครงสร้างไดเร็กทอรีดังที่แสดงด้านล่าง: