אחת המשימות החשובות ביותר בעת יצירת תוכנה היא תיעוד, למרבה הצער לאלו מאיתנו המפתחים עבודה זו, לפעמים זה נראה מייגע, אך אין זה סוד שתיעוד טוב יכול להיות נקודת ההצלחה של כל כלי, שכן גם בעזרה ש ניתן למשתמשים כדי להבין את הפעולה הנכונה של האפליקציה או את המידע שמספק למפתחים אחרים כדי לשפר אותה.
יש יישומים די טובים המאפשרים לנו לתעד את הפרויקטים שלנו בצורה פשוטה, חלקם נוטים להציע יותר ממה שאנחנו באמת רוצים ואחרים דורשים התקנות מורכבות, כלי לתיעוד פרויקטים שתואם ודי פשוט לשימוש ולהתקנה הוא Docusaurus.
מהו דוקוסאורוס?
דוקאזאורוס הוא פרויקט עבור לבנות, ליישם ולתחזק כלי קוד פתוח תיעוד אינטרנט, זה מאפשר להשתמש בשפה Markdown כדי לכתוב את התיעוד שיתפרסם בהמשך כאתר HTML, באותו אופן, הכלי מאפשר לנו להרחיב ולהתאים אישית את עיצוב אתר התיעוד שלנו באמצעות React.
באופן כללי, כלי קוד פתוח זה שפותח על ידי צוות התכנות של פייסבוק מאפשר לנו ליצור בקלות אתרים יפים וקלילים שבהם נוכל להציג בצורה נאותה את התיעוד של כל פרויקט.
הכלי מצויד בפונקציות עבור גרסאות נכונות של מסמכים, מנוע חיפוש מתקדם, אפשרות לתעד ולעצב מחדש את אתר התיעוד שלנו בזמן אמת, אינטגרציה עם תרגומים ותכונות רבות אחרות שיעזרו לכם לדאוג פחות לתיעוד או ליתר דיוק להכנת תהליך התיעוד קל יותר ובגימור נעים יותר.
השימוש הקל בדוקוסאורוס ניתן לראות בגיף הבא שהפיץ המפתחים שלו
כיצד להתקין את Docusaurus?
המטרה העיקרית של Docusaurus היא להיות הכלי הסופי לתיעוד יישומי קוד פתוח המתארחים ב- github, כך שזה ממש קל להתקין ולהפעיל את אתר התיעוד שלך בפלטפורמה זו.
כדי להתחיל ליהנות מ- Docusaurus ב- Github, פשוט עקוב אחר הצעדים שצוינו על ידי צוות הפיתוח ושאותם אנו מצטטים להלן:
- עבור אל שורש ספריית המאגר שלך ב- GitHub, שם תיצור את המסמכים ותפעיל את הפקודות הבאות:
yarn global add docusaurus-init
ornpm install --global docusaurus-init
docusaurus-init
התוצאה הסופית תהיה יצירת קובץ וספרייה כמוצג להלן:
באג מעניין לנסות!