ידע

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

הפרויקט פותח על ידי חברי קהילת מעקף (קהילת הקוד הפתוח של ישראל) וניתן להשתמש בו בחינם ובאופן חופשי.

טכנולוגיות

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

פיצ׳רים 📌

• הפרויקט נבנה ב-preact ועל כן חסכוני ביותר מבחינת זיכרון. בעוד שפרויקטים אחרים בפלטפורמות כגון React.js ו-Next.js מגיעיים לג׳יגה-בייטים של זיכרון, בעוד כאן מדובר על סדר גודל של עשרות קילובייטים בלבד. כלומר, חיסכון פי עשרות עד מאות מונים.

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

דרישות מקדימות 📦

וודאו ש-NodeJS מותקן אצלכם במערכת טרם ההתקנה. תוכלו להריץ את הפקודה הבאה לשם כך בשורת הפקודה או ב-terminal:

node --version

התקנה

הריצו את הפקודה

git clone https://github.com/talisraeli/Yeda.git

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

לאחר מכן הריצו את הפקודה

npm install

על מנת להתקין את כל החבילות הרלוונטיות שנעשה בהן שימוש בפרויקט (כלומר, כל ה-dependencies).

תוכלו להריץ שרת פיתוח לוקאלי עם האתר באמצעות הפקודה:

npm run dev

תצוגה מקדימה 🚀

אתם יכולים לצפות בתצוגה מקדימה של הפרויקט כאן:

https://yeda.talisrae.li/

זכרו שאתם יכולים לשנות את הצבעים ואת התוכן בקלות להעדפות האישיות שלכם.

רישיון 📝

שוחרר תחת רישיון MIT