SassDoc השראה ומודל לאחר JSDoc .
בדיוק כמו כל מחולל תיעוד אחר, SassDoc עובד על ידי גרירה הערות מקבצי SASS / SCSS ויצירת דף יפה, מאורגן היטב תיעוד HTML מהם.
כל התוכן מובנה היטב לחלקים להתמודדות עם פונקציות, משתנה, וmixins. אזכור של קטעי קוד המקוריים והדגשת קוד המקור נתמך גם.
מלבד נושא SassDoc הסטנדרטי, תבניות אחרות זמינות גם.
כדי להשתמש בSassDoc אנא בדוק התיעוד הראשון שלה למידע המתאים על איך לעצב את הערות קוד מקור SASS / SCSS כדי שהם יוכלו להיות מזוהים ושימוש על ידי המנוע של SassDoc.
מה חדש בהודעה זו:
- שדרג לבבל 5.0
- ודא ברירת מחדל שם ערכת נושא מחובר כראוי
- כמה תלות
- Switched לESLint
עדכונים
מה חדש בגרסת 2.1.1:
- גרסת זאס-להמיר עדכון כדי למנוע 6to5-
נושא זמן ריצה מתואר ב.
מה חדש בגרסת 2.0.0:
- כל API כבר refactored באופן מלא בES6
- סימן $ עכשיו אופציונאלי במסגרת קביעה שם בביאורparameter
- עכשיו זה אפשרי להשתמש בדפוסי הדרת קובץ / תיקייה
- עכשיו זה אפשרי לSassDoc צינור לתוך stdin
- - אפשרות לנפות נוספה מידע פלט על התקנה נוכחית
- נושא ברירת מחדל עכשיו יש תצורת googleAnalytics קבלת Google Analytics מעקב מפתח
- נושא ברירת מחדל עכשיו יש תצורת trackingCode קבלת קטע HTML שרירותי להיכלל לפני & # x3c; x3e / גוף & #;
- ביאורcontent הוא כעת בצורה נכונה פלט בנושא ברירת מחדל
- נושא ברירת מחדל מציג כעת את הסוג וכן את השם כאשר פריטי cross-linking (דרישות, וכן הלאה ...)
- הודעות שגיאה צריכה עכשיו להיות מפורשות יותר, מתן שם קובץ ושורה
- - לנתח אפשרות נוסף לנתוני ניתוח גלם פלט כמו JSON מCLI
מה חדש בגרסת 1.10.6:.
- ודא סוג נכון בדיקתsee ביאור
מה חדש בגרסת 1.10.3:.
- requires מנע למילוי אוטומטי של תלות פעמיים
מה חדש בגרסת 1.8.0:
- יכולת נוסף להוסיף הערות משלך לנושא שלך
- תוקן בעיה עם פריטים שהזמינה באופן אקראי
מה חדש בגרסת 1.6.0:
- נוסף Generator Yeoman כדי לעשות את זה יותר קל לבנות נושאים.
- תמיכה נוסף YAML לקבצי תצורה; שם קובץ תצורת ברירת מחדל עדיין להציג, בין אם כ.json, .yaml או .yml.
- הוספת הודעה להזהיר מפני הסתמכות על שם קובץ תצורת ברירת מחדל (תצוגה. {JSON, YAML, YML}) שכן הוא ישבור בגרסה 2.0.0 לטובת .sassdocrc (אשר יתמוך גם בפורמט בו-זמנית בזמן ש להיות יותר סמנטי, פחות מבלבל ופחות סביר לסכסוך עם פרויקטים אחרים).
- תוקן בעיה כאשר הערך 'הפריטים משתנים מכיל נקודה-פסיק.
- משופרת נושא האור (רכיסה טובה יותר הצדדית עם מדינות המאוחסנות בlocalStorage, לעבור טוב יותר קוד, מבנה JavaScript טוב יותר, וביצועים טובים יותר).
מה חדש בגרסת 1.5.2:
- סוג משתמע נוסף למצייני מיקום הנדרשים
מה חדש בגרסת 1.4.1:.
- מבחן שבור קבוע
מה חדש בגרסת 1.3.2:.
- מבחן שבור קבוע
מה חדש בגרסת 1.1.6:
- Backport, קבוע מצא-בעם נתיב מוחלט.
דרישות :
- Node.js
תגובות לא נמצא