מפרסמים תיעוד
כאתר אמיתי
פרסמו builds סטטיים של VitePress, Docusaurus, Nextra, VuePress, MkDocs וכלי תיעוד אחרים עם HTML ידידותי לחיפוש, דומיינים מותאמים אישית, HTTPS ותהליך פרסום צפוי.
פורמטי תיעוד שאנחנו רואים בכל יום
איפה אחסון תיעוד מבולגן
האתר מתגבר על הכלי
כלי מסמכים מתארחים הם נוחים, אך לעתים קרובות צוותים מגיעים למגבלות לגבי מיתוג, דפים מותאמים אישית וכמה שליטה יש להם באתר הסופי.
וויקי בסיסיים מוגבלים מדי
ויקי מתאים להערות. מסמכי מוצר ציבוריים זקוקים בדרך כלל לחיפוש, ניווט קריא, דומיינים מותאמים אישית, מטא נתונים ורושם ראשוני נקי יותר.
ניהול עצמאי גוזל זמן הנדסי
ניהול שרתים, SSL, webhooks לפרסום והיגיינת שחרור לא אמורים להתחרות בכתיבת המסמכים.
בדקו את ה-build לפני הפרסום
העלו את התיקייה שנוצרה
Docusaurus מוציא בדרך כלל build, VitePress משתמש ב-.vitepress/dist, ו-MkDocs כותב ל-site. העלו את הקבצים שנוצרו, לא את Markdown המקור.
אשרו את נתיבי הבסיס
אם התיעוד חי תחת נתיב משנה או פרויקט, ודאו שה-base URL של ה-framework תואם לכתובת הסופית.
בדיקת חיפוש וניווט
פתחו build מקומי לפרסום ובדקו אינדקסי חיפוש, קישורי sidebar, נתיבי גרסאות וקישורי עומק לפני שיתוף ה-URL הציבורי.
שמרו נכסים ידידותיים למטמון
אתרי docs שולחים לרוב תמונות קטנות, גופנים וקובצי JavaScript. פרסום סטטי מקל להגיש את הנכסים האלה דרך CDN.
נבנה עבור יותר מסוג אחד של תיעוד
מסמכי פרויקט בקוד פתוח
פרסמו מדריכים, יומני שינויים ומסמכי הגירה בדומיין ממותג מבלי להפוך את אתר ה-docs לפרויקט תפעול נפרד.
API הפניות
פרסמו אתרי reference נקיים עם חיפוש, ניווט ודוגמאות קוד שקל יותר לסרוק מאשר blob שנוצר אוטומטית.
מאגרי ידע פנימיים
פרסמו מדריכים הנדסיים, runbooks ותיעוד תהליכים במבנה אתר נקי.
תיעוד המוצר
פרסמו מסמכי התחלה, מדריכי הגדרה והפניות לתכונות שנשארים מהירים עבור לקוחות בכל אזור.
עיצוב מערכות
חשפו שימוש ברכיבים, אסימונים ותבניות באתר הניתן לניווט שיכול לגדול עם המוצר.
עובד עם ערימות המסמכים הסטטיות העיקריות
שאלות נפוצות בנושא אחסון תיעוד
האם אוכל לפרסם כאן פלט של VitePress או Docusaurus?
כן. הריצו קודם את build ה-framework, ואז העלו את תיקיית הפלט הסטטית שנוצרה. DeployPages מגיש את ה-HTML, CSS, JavaScript והנכסים הסופיים.
כיצד פועלים דומיינים מותאמים אישית עבור אתרי מסמכים?
הוסיפו את הדומיין אחרי הפרסום, כוונו את רשומת ה-DNS ליעד שסופק, ו-DeployPages יפעיל HTTPS באופן אוטומטי.
האם אני יכול לארח גם תיעוד פרטי?
ההתאמה החזקה ביותר כיום היא תיעוד פומבי ומסמכי מוצר פתוחים. בקרת הגישה מתרחבת, אבל התהליך המרכזי כיום הוא פרסום סטטי.
האם זה עוזר עם SEO?
זה יכול. HTML סטטי, כתובות URL נקיות, מטא נתונים שימושיים והגשה מהירה מעניקים לתיעוד בסיס טכני חזק יותר לנראות חיפוש.
פרסום build של תיעוד כאתר
העלו את תיקיית התיעוד שנוצרה ותנו לקוראים מקום מהיר וממותג למצוא תשובות.
תומך ב-HTML, CSS, JS ונכסי תיעוד סטטיים טיפוסיים.