כיצד ליצור ויקי פנימי פשוט באמצעות Gitbook

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

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

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

כיצד להתחיל להשתמש ב-GitBook

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

GitBook תומך Markdown, שפת סימון פופולרית עם יתרונות רבים לכתיבה או תיעוד באינטרנט.

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

1. הירשם ל-GitBook. אם יש לך חשבון GitHub משלך, אתה יכול ללחוץ על הירשם עם GitHub.
2. לאחר שנכנסת, GitBook יפנה אותך לוויקי פנימי חדש. זה גם יאכלס מראש את הוויקי שלך עם תוכן לדוגמה.

סקירה כללית של ממשק GitBook

ל-GitBook מספר פונקציות המאפשרות לך לבנות ולבצע שינויים באתר התיעוד שלך.

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

כיצד ליצור טיוטה חדשה

אתה יכול ליצור טיוטה חדשה על ידי יצירת בקשת שינוי חדשה וביצוע שינויים בתוכה.

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

כיצד ליצור דפים וקבוצות

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

1. צור דף חדש על ידי לחיצה על עמוד חדש קישור בתחתית סרגל הצד, ובחירה דף מסמך חדש מהתפריט הנפתח. לחלופין, אתה יכול לרחף מתחת לדף קיים וללחוץ על הכחול ועוד לַחְצָן.
2. כדי ליצור קבוצת דפים חדשה, לחץ על עמוד חדש, ובחר את ה קבוצה חדשה אפשרות מהתפריט הנפתח.
3. ניתן לשנות את שם העמוד על ידי לחיצה על שלוש הנקודות שליד העמוד או הקבוצה, ובחירה שנה שם.
4. התחל להוסיף תוכן כדי לאכלס את הדף החדש שלך. אתה יכול להוסיף תוכן פשוט כגון טקסט או כותרות. GitBook גם מאפשר לך להוסיף בלוקי תוכן אחרים כגון תמונות, קבצים מצורפים, טבלאות, כרטיסיות או קטעי קוד. ישנה גם אפשרות להוסיף אינטגרציות אחרות כגון הטמעות של YouTube או תוכן של Google Docs.
5. הקלק על ה מבט שונה לחצן בחלונית התחתונה כדי להציג את ההבדלים בין הטיוטה שלך לבין עותק התיעוד הראשי המקורי.
6. לאחר שתסיים לכתוב את התוכן שלך, תוכל ללחוץ על לְמַזֵג, שלח ומיזוג, או שלח לסקירה.

אתה יכול לגשת לקישור השיתוף מהחלונית העליונה של GitBook. תצטרך להיות מחוץ לטיוטה ולראות את עותק התיעוד הראשי כדי שתוכל לראות את הקישור.

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

יצירת תיעוד באמצעות GitBook

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

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

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