תחילת העבודה עם GitBook: כיצד להוסיף בלוקי תוכן

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

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

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

כיצד להוסיף בלוקי תוכן ב-GitBook

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

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

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

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

1. בדף באתר התיעוד שלך, לחץ על ועוד לחצן במיקום שבו תרצה להוסיף את התוכן שלך.
instagram viewer
2. מהתפריט הנפתח, אתה יכול לגלול ברשימה כדי להציג את אפשרויות התוכן השונות.
3. מכאן, בחר כל סוג תוכן פשוט, כגון פסקה, גוש קוד, כותרת או ציטוט. GitBook ישנה אוטומטית את התוכן כך שיתאים לפורמט שבחרת.

כיצד להוסיף תמונות או קבצים מצורפים

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

1. פתח דף באתר התיעוד שלך. הקלק על ה ועוד לחצן לפתיחת התפריט הנפתח עבור בלוקי תוכן זמינים.
2. בחר הכנס תמונות.
3. בחלונית הימנית שמופיעה, ישנן שלוש כרטיסיות. ה קבצים הכרטיסייה מאפשרת לך להעלות קובץ תמונה משלך. ה כתובת אתר הכרטיסייה מאפשרת קישור לתמונה באינטרנט. אתה יכול גם לפתוח את Unsplash לשונית. זה המקום שבו אתה יכול לבחור תמונות קיימות שאינן דורשות ייחוס.
4. לאחר שהוספת תמונה, לחץ על שלוש נקודות כפתור הממוקם בפינה השמאלית העליונה של התמונה. פעולה זו תפתח תפריט נפתח שבו תוכל ליישר את התמונה, או למחוק אותה. אתה יכול גם לתת לתמונה כיתוב.
5. כדי להוסיף קבצים, הצב את הסמן בכל מקום בדף באתר התיעוד שלך. הקלק על ה ועוד לחצן כדי לפתוח את התפריט הנפתח סוגי בלוק תוכן. הפעם, לחץ על להכניס קבצים אוֹפְּצִיָה.
6. חלונית דומה תופיע ביד ימין, המאפשרת לך להעלות כל קובץ מצורף במקום תמונה. לחץ על עיין בקבצים כדי לבחור קובץ המאוחסן באופן מקומי במחשב שלך.
7. הקובץ יופיע ברשימה. לחץ על הקובץ, ו-GitBook תיצור בלוק תוכן עם הקובץ המצורף בעמוד שפתחת. לחיצה על בלוק תוכן זה תוריד את הקובץ המצורף.

כיצד להוסיף רמזים

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

1. כדי להוסיף רמז, לחץ על ועוד לחצן לפתיחת התפריט הנפתח עבור בלוקי תוכן זמינים.
2. בחר רֶמֶז.
3. זה יוסיף רמז לעמוד שלך. כברירת מחדל, סוג הרמז הוא "מידע", ומכיל סמל כחול.
4. אתה יכול לשנות את סוג הרמז על ידי לחיצה על הסמל. זה יעבור בלולאה בין ארבעת סוגי הרמז השונים.

כיצד להוסיף טבלאות

אתה יכול להוסיף טבלאות על ידי בחירה ב- שולחן אפשרות מהרשימה הנפתחת. לאחר שהטבלה תהיה בעמוד, תוכל להוסיף שורות או עמודות חדשות. ניתן גם לשנות את השמות וסוגי הנתונים של העמודות, ולשנות את הנתונים בתוך הטבלה.

1. הקלק על ה ועוד לחצן לפתיחת התפריט הנפתח עבור בלוקי תוכן זמינים.
2. בחר שולחן.
3. לחץ על כותרת העמודה בטבלה. זה יפתח תפריט קטן יותר, שבו תוכל לשנות את שם העמודה שנבחרה. תפריט זה מאפשר לך גם למחוק או להסתיר את העמודה שנבחרה. עבור סוגי נתוני עמודות מסוימים, תוכל גם ליישר את התוכן בתוך העמודה.
4. כברירת מחדל, סוג הנתונים שנבחר עבור העמודות הוא "טקסט". לחץ על הכפתור עם ה- ט סמל כדי לשנות את סוג הנתונים. אתה יכול לשנות אותו למספר, תיבת סימון, תפריט נפתח, קובץ מצורף, דירוג ועוד.
5. הקלק על ה סמל שש נקודות ליד הפינה השמאלית העליונה של הטבלה. כאן תוכלו להוסיף עמודות ושורות חדשות או למחוק את כל הטבלה. ניתן גם להסתיר או להציג עמודות מסוימות, או לשנות מאפיינים אחרים לטבלה.

כיצד להוסיף בלוקים של קישורי עמוד

בלוקים של קישורי עמוד הם קישורים שתופסים את כל השורה בעמוד. כשאתה מוסיף את הקישור, אתה צריך לקשר לדף שייפתח כשמישהו ילחץ עליו.

1. הקלק על ה ועוד לחצן לפתיחת התפריט הנפתח עבור בלוקי תוכן זמינים.
2. לחץ על קישור לעמוד.
3. מהתפריט הנפתח החדש, בחר את הדף שאליו אתה מקשר.
4. הקישור לדף שלך יופיע בתוך בלוק בדף.

שימוש ב-GitBook לתיעוד

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

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

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

אם אתה יוצר תיעוד הקשור לשפת Go, אתה יכול להשתמש ב-Godoc. Godoc מאפשר לך לתעד אוטומטית את קוד ה-Go שלך.