Menu

עורך Markdown

לכתוב Markdown עם תצוגה מקדימה חיה במסך מפוצל.

מאת Nethanel Bar, Co-founder & CEO

עודכן לאחרונה

מוכנים ללמוד תכנות באמת?

ב-Coddy לומדים דרך כתיבת קוד אמיתי בדפדפן: שיעורים אינטראקטיביים, משוב מיידי ועזרה מ-AI כשנתקעים.

מהו עורך Markdown?

עורך Markdown הוא סביבת כתיבה של זה לצד זה: בצד אחד מקלידים Markdown בטקסט פשוט, ובצד השני התצוגה המקדימה המעובדת מתעדכנת בזמן אמת. זה הפורמט שמאחורי קובצי README ב-GitHub, פורטלי תיעוד, מחוללי אתרים סטטיים, פלטפורמות בלוגים, אפליקציות הערות כמו Obsidian וכלי צ'אט כמו Discord ו-Slack.

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

רוב עורכי ה-Markdown המודרניים תומכים ב-*GitHub-Flavored Markdown* (GFM), שמוסיף טבלאות, רשימות משימות, בלוקי קוד עם ציון שפה, קישורים אוטומטיים וקו חוצה מעל מפרט CommonMark המקורי.

מה תלמדו תוך כדי שימוש בעורך Markdown

  • Markdown הוא טקסט פשוט: קריא בעורך *וגם* ניתן לעיבוד ל-HTML, בלי סרגל כלים ובלי עיצוב נסתר.
  • כותרות, רשימות, קישורים והדגשות מכסים 90% מהכתיבה הרגילה. טבלאות ובלוקי קוד מכסים את רוב 10% הנותרים.
  • בלוקי קוד עם ציון שפה (```js, ```python) מפעילים הדגשת תחביר ברבים מהמעבדים.
  • Markdown מומר ל-HTML בזמן העיבוד. אותו מקור מפיק פלט עקבי בכל מקום שבו משתמשים במעבד CommonMark/GFM.

איך להשתמש בעורך Markdown, צעד אחר צעד

  1. התחילו להקליד בחלונית העריכה

    השתמשו ב-# לכותרות, ב-* או _ להדגשה וב-- לרשימות. חלונית התצוגה המקדימה מתעדכנת תוך כדי הקלדה.

  2. הוסיפו מבנה

    הוסיפו כותרות, בלוקי קוד וטבלאות כדי לארגן את המסמך. לרוב העורכים יש קיצורי מקלדת (Ctrl+B, Ctrl+I) לעיצוב הנפוץ.

  3. צפו ב-HTML המעובד

    השוו את התצוגה החיה למקור. אם משהו לא מוצג כמו שציפיתם, בדרך כלל חסרה במקור שורה ריקה או שסימון בלוק קוד לא נסגר כראוי.

  4. העתיקו או הורידו

    העתיקו את מקור ה-Markdown לקובץ ה-README, או העתיקו את ה-HTML לאימייל, למערכת ניהול תוכן או לכל מקום שלא מבין Markdown.

דף עזר לתחביר Markdown

ה-80% של Markdown שתשתמשו בהם כל יום. כל השאר נמצא בחיפוש קצר בגוגל. מפרטים: CommonMark ו-GitHub-Flavored Markdown.

רכיבMarkdownמוצג כ
כותרת 1# כותרתכותרת ברמה העליונה
כותרת 2## פרקכותרת פרק
מודגש**חזק****חזק**
נטוי*הדגשה* או _הדגשה_*הדגשה*
קוד בשורה`code`code
בלוק קודעטפו את הקוד בשלושה backticks, עם ציון שפה אופציונליבלוק עם הדגשת תחביר
קישור[טקסט](https://example.com)קישור לחיץ
תמונה![alt](url)תמונה מוטמעת
רשימה- פריטרשימת תבליטים
רשימה ממוספרת1. פריטרשימה מסודרת
רשימת משימות (GFM)- [x] בוצעתיבת סימון מסומנת
טבלה (GFM)| a | b |\n|---|---|\n| 1 | 2 |טבלה בת שתי עמודות
ציטוט> ציטוטציטוט מוזח

דוגמאות Markdown לנסות

פתיחה טיפוסית של README

מקור
# Project Name
A short description in one or two sentences.
## Install
```bashnpm install project-name```
## Quick start
- Step 1- Step 2- Step 3

כותרת, פסקה, פקודת התקנה בבלוק קוד ורשימת תבליטים: זה עמוד השדרה של כל README טוב.

טבלאות (בסגנון GitHub)

מקור
| Feature | Free | Pro ||---------|:----:|:---:|| Editor  |  ✓   |  ✓  || Export  |      |  ✓  |

קווים אנכיים (|) מפרידים בין עמודות. שורת המקפים מגדירה את העמודות, ותווי : קובעים את היישור (שמאל, מרכז, ימין). טבלאות GFM לא צריכות רוחב עמודות מדויק, רק המבנה חשוב.

רשימת משימות

מקור
- [x] Draft the post- [x] Add screenshots- [ ] Publish

GitHub מציג אותן כתיבות סימון אינטראקטיביות בתוך issues ו-PRs. שימושי לרשימות בדיקה בתוך מסמך ולמעקב פרויקטים קליל.

טעויות Markdown נפוצות

  • שוכחים שורות ריקות סביב רשימות, טבלאות ובלוקי קוד. רוב המעבדים צריכים שורה ריקה כדי להתחיל בלוק חדש.
  • מערבבים טאבים ורווחים בתוך רשימה: חלק מהמעבדים ישברו את ההזחה בשקט.
  • שמים HTML גולמי בתוך בלוק קוד ומצפים שיעובד. בלוקי קוד הם *מילוליים*, זו כל המטרה.
  • מניחים שכל ה-Markdown זהה. CommonMark, GFM וגרסאות אחרות נבדלים בפרטים עדינים (שבירות שורה, קישורים אוטומטיים, HTML מוטמע).
  • משתמשים ב-> להזחה במקום לציטוטים. > *פירושו* ציטוט, בחרו דרך אחרת להזיח.

שאלות נפוצות על עורך Markdown

מה זה Markdown?
Markdown היא שפת סימון קלה שממירה תחביר פשוט בטקסט רגיל (# כותרת, **מודגש**, [קישור](url)) ל-HTML מעוצב. היא נועדה להיות קריאה גם בצורת המקור.
איך ממירים Markdown ל-HTML?
הדביקו את ה-Markdown בעורך Markdown והעתיקו את ה-HTML המעובד, או הריצו ממיר כמו marked, markdown-it או pandoc. רוב מחוללי האתרים הסטטיים עושים זאת אוטומטית בזמן הבנייה.
מה ההבדל בין Markdown ל-GitHub-Flavored Markdown?
GitHub-Flavored Markdown (GFM) מוסיף טבלאות, בלוקי קוד עם ציון שפה, רשימות משימות, קישורים אוטומטיים וקו חוצה מעל Markdown הסטנדרטי. זה הניב שבו משתמשים GitHub, GitLab ופלטפורמות תיעוד רבות.
אפשר להשתמש ב-HTML בתוך Markdown?
כן, רוב המעבדים מעבירים HTML גולמי כמו שהוא. זה שימושי להטמעת דברים ש-Markdown לא תומך בהם באופן מובנה (פריסות מותאמות, תגיות וידאו), אבל זה קושר את המסמך לפלט HTML.
האם עורך ה-Markdown פרטי?
כן. העורך של Coddy מעבד Markdown כולו בדפדפן שלכם, והטקסט שלכם לא מועלה לשום מקום.

למידע נוסף

כלי פיתוח נוספים

איור של שפות התכנות ב-Coddy

ללמוד תכנות עם Coddy

להתחיל