ב-Look Scanned, אנו משפרים באופן מתמיד את התשתית שלנו כדי לספק תיעוד טוב יותר ושיטות פיתוח מאובטחות יותר. היום, אנו נרגשים לשתף פרטים על שדרוג משמעותי באתר התיעוד How-To שלנו: מעבר מאפליקציית Vue + Vite מותאמת אישית ל-VitePress, תוך שיפור אבטחת CI/CD שלנו עם npm Trusted Publishers.
📚 מדוע עברנו ל-VitePress
אתר התיעוד How-To שלנו (github.com/lookscanned/how-to) משמש כמדריך שימוש מקיף ל-Look Scanned. למרות שההגדרה הקודמת שלנו Vue + Vite עבדה היטב, זיהינו ש-VitePress יהיה בחירה טובה יותר עבור אתר תיעוד מונחה תוכן.
מהו VitePress?
VitePress הוא מחולל אתרים סטטיים שתוכנן במיוחד לתיעוד. בנוי על גבי Vite ו-Vue 3, הוא משלב את הטוב ביותר משני העולמות: חוויית פיתוח מהירה במיוחד עם תכונות תיעוד רבות עוצמה מהקופסה.
יתרונות מפתח של ההעברה
🎯 ארכיטקטורה טובה יותר לתיעוד
- ניתוב מבוסס קבצים: כל קובץ markdown הופך אוטומטית לדף, מה שהופך את ארגון התוכן לאינטואיטיבי
- תכונות תיעוד מובנות: תוכן עניינים, חיפוש, בינלאומיות ועוד מגיעים מוגדרים מראש
- יצירת אתר סטטי: HTML מעובד מראש מספק SEO מעולה וטעינת דפים מיידית
⚡ חוויית מפתח משופרת
- טעינה חמה מיידית: שינויים מופיעים מיד במהלך הפיתוח
- Markdown ראשון: התמקדות בתוכן, לא בבניית רכיבים
- תמיכה ברכיבי Vue: כאשר נדרש, אנו עדיין יכולים להשתמש ברכיבי Vue מותאמים אישית בתוך markdown
🔧 תחזוקה קלה יותר
- מבנה ברור יותר: התיעוד עוקב אחר מוסכמות, מה שמפחית את העומס הקוגניטיבי עבור תורמים
- בנייה יציבה יותר: המבנה בעל הדעות של VitePress מוביל לבנייה הניתנת לשחזור יותר
- שיתוף פעולה טוב יותר: חברי צוות יכולים לתרום לתיעוד ללא ידע עמוק ב-Vue
🔒 אבטחה משופרת עם npm Trusted Publishers
לצד העברת VitePress, יישמנו שיפור אבטחה קריטי: npm Trusted Publishers באמצעות אימות OIDC.
הבעיה עם טוקנים npm מסורתיים
בעבר, פרסום חבילות ל-npm דרש אחסון NPM_TOKEN לטווח ארוך בסודות המאגר. לגישה זו יש מספר חסרונות:
- סיכון אבטחה: טוקנים עלולים להיחשף בטעות או להיפגע
- עומס ניהול: טוקנים דורשים סיבוב ועדכונים ידניים
- אתגרי ביקורת: קשה לעקוב אחר מי פרסם מה ומתי
הפתרון: פרסום מהימן מבוסס OIDC
npm Trusted Publishers ממנף OpenID Connect (OIDC) כדי לאפשר פרסום מאובטח ללא טוקנים ישירות מ-GitHub Actions. כך זה עובד:
- אין סודות מאוחסנים: במקום לשמור טוקנים, GitHub Actions מבקש אישורים קצרי טווח מ-npm
- אימות זהות: npm מאמת שבקשת הפרסום הגיעה מהמאגר GitHub המורשה
- ניהול אישורים אוטומטי: אישורים מונפקים אוטומטית ופגים במהירות
יתרונות בעולם האמיתי
שינוי זה מביא שיפורים מיידיים לזרימת העבודה הפיתוחית שלנו:
- ✅ אין יותר ניהול טוקנים: אין צורך ליצור, לאחסן או לסובב טוקני npm
- ✅ פני תקיפה מופחתים: אישורים קצרי טווח ממזערים את סיכון החשיפה
- ✅ יכולת ביקורת טובה יותר: כל פעולת פרסום מקושרת להרצת GitHub Actions ספציפית
- ✅ שיטות עבודה מודרניות מומלצות: מיישר עם עקרונות אבטחת אפס אמון
הערה טכנית: כדי לתמוך ב-npm Trusted Publishers, עדכנו את תצורת ה-CI שלנו להשתמש ב-Node.js lts/*, מה שמבטיח שיש לנו את גרסת npm העדכנית ביותר הנדרשת לאימות OIDC.
📦 ציר הזמן של השחרורים
ההעברה הושלמה דרך שלושה שחרורים ב-19 בדצמבר 2025:
- v2.0.0: העברה מרכזית מ-Vue + Vite ל-VitePress (שינוי שובר)
- v2.0.1: תיקון CI לתמיכה ב-npm Trusted Publishers עם גרסת Node.js המתאימה
- v2.0.2: שיפור ביצועים על ידי העברת
@fontsource/noto-monoל-devDependencies
🌍 תמיכה רב-לשונית מתמשכת
הערה חשובה: התיעוד How-To שלנו מייצר PDF-ים רב-לשוניים ששימשו תמיד כקבצי דוגמה באפליקציית Look Scanned הראשית (זמין ב-lookscanned.io/en/scan). העברת VitePress זו אינה משנה את הפונקציונליות הזו—היא פשוט מספקת בסיס טוב יותר לתחזוקה ושיפור של תשתית התיעוד שלנו.
💡 מה זה אומר למשתמשים
אם אתה משתמש בתיעוד של Look Scanned:
- אותה גישה, חוויה טובה יותר: התיעוד נשאר באותו URL עם טעינה וניווט משופרים
- אמין יותר: יצירת אתר סטטי משמעותה טעינות מהירות יותר ויציבות טובה יותר
- חיפוש וגילוי טובים יותר: החיפוש המובנה של VitePress עוזר לך למצוא תשובות מהר יותר
- תמיכה מתמשכת ב-PDF: יצירת PDF רב-לשוני נמשכת כמו קודם
🚀 מה הלאה
עם השדרוג של התשתית הושלם, אנו מתמקדים בשיפורי תוכן:
- מקרי שימוש מורחבים: יותר דוגמאות מעשיות ומדריכים צעד אחר צעד
- שיפורי עקביות: חידוד טרמינולוגיה רב-לשונית לבהירות
- ייצוא PDF משופר: שיפור חוויית יצירת PDF חוצת דפדפנים
נסה את Look Scanned היום
Look Scanned מספק אפקטים של סריקת PDF מבוססת דפדפן, המעדיפה פרטיות ללא העלאת הקבצים שלך לשום מקום. התיעוד המשופר הופך את תחילת העבודה לקלה יותר מאי פעם.
👉 בקר ב-lookscanned.io כדי לחוות סריקת מסמכים מהירה ומאובטחת בדפדפן שלך.