כיצד לכלול דיאגרמות של בת ים בפרויקט GitHub שלך

פלטפורמת שיתוף הקוד הפופולרית, GitHub, הכריזה על תמיכה בסוג חדש של תוכן מוטבע. בקבצי סימון, כעת תוכל להשתמש בתחביר בת הים כדי ליצור בקלות תרשימי זרימה, דיאגרמות רצף ועוד.

הטעם של GitHub של הסימון כבר מטפל בתמונות, רשימות משימות וקודי אמוג'י קצרים. עם תמיכה בדיאגרמות נפוצות, GitHub עושה את שלו לתיעוד אינפורמטיבי ושימושי יותר.

מה חדש ב-GitHub?

כעת תוכל להטמיע קוד בתולת הים שלך README.md וקבצי סימון אחרים. אם תעשה זאת, GitHub יציג תרשים המתואר על ידי הקוד הזה. קוד בתולת הים משתמש בתחביר פשוט שמתאר את החלקים הנפרדים של כל דיאגרמה בטקסט רגיל.

ראה גם: מה זה GitHub? מבוא לתכונות הבסיסיות שלו

איך אתה כולל דיאגרמות?

1. בחר קובץ סימון קיים או צור קובץ חדש להוספה למאגר שלך. השתמש בשניהם .md אוֹ .markdown הרחבות.
2. הוסף קוד של בת ים לקובץ הזה. איזה קוד בדיוק תלוי בך; הנה דוגמה פשוטה להתחיל:

   גרף TD;
    א-->ב;
    א-->ג;
    ב-->ד;
    ג-->ד;

3. הצג את הקובץ ב-GitHub. אתה אמור לראות עיבוד יפה של הדיאגרמה שלך.

עכשיו אתה רק צריך ללמוד את שפע הדיאגרמות שיש ל-Mermain. או שאתה יכול פשוט להתייחס ל בתולת ים תיעוד כאשר אתה צריך דיאגרמה.

באילו סוגי דיאגרמות אוכל להשתמש?

בת הים תומכת בסוגי הדיאגרמות הבאים:

• תרשים זרימה
• סדר פעולות
• מעמד
• מדינה
• יחסי ישות
• מסע משתמש
• גאנט
• פַּאִי
• דְרִישָׁה

ראה גם: טבלת גאנט לעומת תרשים PERT: מהם ההבדלים?

לכל אחד יש תחביר משלו, כדי לשקף את סוג הנתונים שהדיאגרמה מציגה. לדוגמה, הנה הקוד לתרשים רצף פשוט:

תרשים רצף
 בארט->>הומר: אין לך פרה, בנאדם.

מה שנראה כך בעיבוד:

והנה הקוד לתרשים מצב בסיסי:

stateDiagram-v2
 [*] --> חדש
 חדש --> מוכן: הודה
 מוכן --> פועל: שיגור מתזמן
 פועל --> מוכן: להפריע
 פועל --> המתנה: קלט/פלט או המתנה לאירוע
 ממתין --> מוכן: קלט/פלט או השלמת אירוע
 פועל --> הסתיים: יציאה
 הסתיים --> [*]

מה שמציג ככזה:

הוסף ערך לפרויקטי GitHub שלך עם דיאגרמות של בת ים

דיאגרמות בתולת ים הן תוספת שימושית ל-GitHub, במיוחד מכיוון שאנו מאמינים שהם מעודדים תיעוד טוב יותר. ניתן לשפר פרויקטים רבים עם כמה מסבירים חזותיים ישירות בתיעוד או בקבצי README.

GitHub הוא כעת שירות כה פופולרי, התכונות והשינויים שלו משפיעים על מפתחים רבים ברחבי העולם. למרבה המזל, תמיכה בדיאגרמות של בת הים קיימת אם אתה צריך אותה, ובלתי נראית אם לא. אבל, בתקווה, תתחיל לראות תיעוד נחמד יותר לכל הפחות.

כיצד לארח אתר בחינם באמצעות דפי GitHub

אם יש לך אתר פשוט, אינך צריך לשלם עבור אחסון אתרים. אתה יכול להשתמש בדפי GitHub בחינם!

קרא הבא

על הסופר