למה זה קיים
אנחנו מספקים יישום ממוקד תיעוד שמוכיח שתוכן המנוהל ב-CMS יכול להפוך לאתר תיעוד מלוטש בלי לבנות מחדש את שכבת הרינדור.
השתמשו בזה כאשר
- מארחים תיעוד של מוצר על גבי תוכן CMS
- מרנדרים מסמכים עתירי Markdown
- בונים ניווט לתיעוד המונע על ידי סרגל צד וחיפוש
מה זה כולל
- אפליקציית Next.js בשם תבנית-התיעוד
- רינדור של נתיב catch-all הנתמך על ידי CMS
- גבול ה-Markdown של התיעוד
- רכיבי ניווט עליון, סרגל צד ותוכן ייעודיים לתיעוד
- טעינת פוסטים וקטגוריות המודעת לשפה
תהליך העבודה המרכזי
- הגדירו את אפליקציית התיעוד עם משתני הסביבה של ה-CMS.
- רנדרו את מסלולי התיעוד דרך
cms-renderer. - שלפו מסמכי קטגוריות ופוסטים מסכמות ה-CMS.
- רנדרו תוכן Markdown באמצעות רכיבים ייעודיים לתיעוד.
- הוסיפו שכבת ניווט וחיפוש עשירה יותר מעל.
ממשקי המערכת
- שכבת הנתיבים של אפליקציית התיעוד
- שכבת רכיבי הממשק של התיעוד
- עזרי נתונים ו-URL של ה-CMS לתיעוד