Markdown Cheat Sheet: דף עזר לתחביר
עודכן לאחרונה
כותרות
שימו רווח אחרי סימני ה-#. מספר הסימנים קובע את הרמה, מ-1 עד 6.
| רכיב | Markdown | תוצאה |
|---|---|---|
| כותרת 1 | # Page title | כותרת ברמה העליונה, <h1> |
| כותרת 2 | ## Section | כותרת של אזור, <h2> |
| כותרת 3 | ### Subsection | כותרת של תת-אזור, <h3> |
| כותרות 4 עד 6 | #### Level 4
##### Level 5
###### Level 6 | <h4>, <h5> ו-<h6> |
| כותרת 1, צורה חלופית | Page title
========== | <h1>, זהה ל-# Page title |
| כותרת 2, צורה חלופית | Section
------- | <h2>, זהה ל-## Section |
| סימני # סוגרים | ## Section ## | <h2>Section</h2>; סימני # בסוף מושמטים |
| רווח חסר | #Not a heading | פסקה רגילה. הרווח אחרי # הוא חובה |
מודגש, נטוי וקו חוצה
כוכביות עובדות בכל מקום, גם בתוך מילה. קווים תחתונים עובדים רק בגבולות של מילה, כך ש-snake_case נשאר כפי שהוקלד.
| רכיב | Markdown | תוצאה |
|---|---|---|
| מודגש | **bold text** | מודגש, <strong>bold text</strong> |
| מודגש, עם קווים תחתונים | __bold text__ | מודגש, זהה לשורה הקודמת |
| נטוי | *italic text* | נטוי, <em>italic text</em> |
| נטוי, עם קווים תחתונים | _italic text_ | נטוי, זהה לשורה הקודמת |
| מודגש ונטוי | ***bold and italic*** | <em><strong>bold and italic</strong></em> |
| הדגשה בתוך מילה | un**believ**able | רק האמצע של המילה מודגש |
| קווים תחתונים בתוך מילה | snake_case_name | טקסט רגיל, בלי נטוי |
| קו חוצה (GFM) | ~~no longer true~~ | טקסט מחוק בקו, <del>no longer true</del> |
| קו תחתון | <ins>underlined</ins> | טקסט עם קו תחתון. אין ב-Markdown תחביר לקו תחתון, ולכן זה HTML |
| סימון בצבע | <mark>highlighted</mark> | טקסט מסומן באתרים שמאפשרים את התגית <mark>. אין ב-Markdown תחביר לסימון |
ירידות שורה ופסקאות
לחיצה אחת על Enter בתוך פסקה לא מתחילה שורה חדשה בפלט. השתמשו באחת מהאפשרויות האלה במקום.
| רכיב | Markdown | תוצאה |
|---|---|---|
| פסקה חדשה | First paragraph.
Second paragraph. | שתי פסקאות. שורה ריקה מפרידה ביניהן |
| ירידת שורה: שני רווחים | Roses are red,
Violets are blue. | פסקה אחת עם <br> אחרי red,. השורה הראשונה מסתיימת בשני רווחים, שאי אפשר לראות |
| ירידת שורה: לוכסן הפוך | Roses are red,\
Violets are blue. | אותו <br>, עם סימן שאפשר לראות. עובד ב-CommonMark וב-GitHub |
| ירידת שורה: HTML | Roses are red,<br>Violets are blue. | אותו <br>. עובד גם בתוך תא של טבלה |
| ירידת שורה בודדת | Roses are red,
Violets are blue. | שורה אחת: Roses are red, Violets are blue. ב-issues ובתגובות של GitHub ירידת השורה נשמרת; בקבצי .md לא |
| שורות ריקות נוספות | One.
Two. | זהה לשורה ריקה אחת. לרווח גדול יותר, שימו <br> בשורה נפרדת |
רשימות
הזיחו פריט מקונן כך שיתיישר עם הטקסט של הפריט שמעליו: 2 רווחים מתחת ל-- , 3 רווחים מתחת ל-1. .
| רכיב | Markdown | תוצאה |
|---|---|---|
| רשימה עם תבליטים | - Apples
- Pears
- Plums | רשימה עם תבליטים, <ul> עם שלושה <li> |
| תבליטים אחרים | * Apples
+ Pears | גם * ו-+ יוצרים תבליטים. החלפת התו מתחילה רשימה חדשה |
| רשימה ממוספרת | 1. Install
2. Configure
3. Run | רשימה ממוספרת, <ol> |
| מספור עצל | 1. Install
1. Configure
1. Run | עדיין ממוספרת 1, 2, 3. רק המספר הראשון קובע |
| התחלה ממספר מסוים | 7. Seventh
8. Eighth | <ol start="7">, ממוספרת החל מ-7 |
| רשימה מקוננת | - Fruit
- Apple
- Pear
- Vegetables | רשימה בתוך הפריט הראשון |
| מקוננת, ממוספרת | 1. Download
- Windows
- macOS
2. Install | תבליטים בתוך שלב 1, בהזחה של 3 רווחים |
| פסקה בתוך פריט | - First item
More about the first item.
- Second item | שתי פסקאות בתוך הפריט הראשון |
| קוד בתוך פריט | 1. Run this:
```bash
npm install
```
2. Start the app | בלוק קוד בתוך שלב 1, בהזחה עד הטקסט של הפריט |
רשימות משימות (תיבות סימון)
הרחבה של GitHub Flavored Markdown: פריט ברשימה שמתחיל ב-[ ] או ב-[x] הופך לתיבת סימון.
| רכיב | Markdown | תוצאה |
|---|---|---|
| תיבה ריקה | - [ ] Write tests | תיבת סימון לא מסומנת |
| תיבה מסומנת | - [x] Write tests | תיבת סימון מסומנת. גם [X] עובד |
| רשימת תיוג | - [x] Draft
- [ ] Review
- [ ] Publish | תיבה מסומנת אחת ושתיים ריקות. ב-issues וב-pull requests של GitHub אפשר לסמן אותן בלחיצה |
| משימות מקוננות | - [ ] Release
- [x] Tag the commit
- [ ] Write the notes | שתי תת-משימות מתחת לתיבה הראשונה |
| רווח חסר | - [] Write tests | תבליט רגיל שמציג [] Write tests. בתוך הסוגריים צריך רווח או x |
קישורים
טקסט הקישור נכתב בסוגריים מרובעים והכתובת בסוגריים עגולים מיד אחריו, בלי רווח ביניהם.
| רכיב | Markdown | תוצאה |
|---|---|---|
| קישור בתוך השורה | [Coddy](https://coddy.tech) | <a href="https://coddy.tech">Coddy</a> |
| קישור עם כותרת | [Coddy](https://coddy.tech "Learn to code") | אותו קישור. הכותרת מוצגת כ-tooltip במעבר עכבר |
| URL בסוגריים משולשים | <https://coddy.tech> | ה-URL עצמו, כקישור |
| URL חשוף (GFM) | https://coddy.tech | קישור ב-GitHub ובאתרי GFM אחרים, שמקשרים גם כתובות www.. טקסט רגיל ב-CommonMark קפדני |
| קישור לאימייל | <hello@example.com> | קישור mailto: |
| קישור בהפניה | Read the [docs][1].
[1]: https://example.com/docs | docs מקשר ל-URL. השורה [1]: לא מוצגת |
| הפניה מקוצרת | See [GitHub].
[GitHub]: https://github.com | GitHub מקשר ל-URL |
| קישור יחסי | [Install guide](docs/install.md) | קישור לקובץ ביחס לקובץ הנוכחי. ב-GitHub הוא פותח את הקובץ במאגר |
| קישור לכותרת | [Jump to setup](#getting-started) | גולל אל ## Getting Started באותו עמוד |
| מזהי כותרות | ## Getting Started! | מקבלת ב-GitHub את המזהה getting-started: אותיות קטנות, רווחים הופכים למקפים, וסימני פיסוק מלבד - ו-_ מושמטים |
| כותרת בקובץ אחר | [Requirements](docs/install.md#requirements) | פותח את הקובץ בכותרת הזו |
| רווחים ב-URL | [Report](my%20report.pdf) | כתבו כל רווח כ-%20, או עטפו את ה-URL בסוגריים משולשים: [Report](<my report.pdf>) |
| פתיחה בלשונית חדשה | <a href="https://coddy.tech" target="_blank">Coddy</a> | אין ב-Markdown תחביר לכך. ה-HTML עובד באתרים ששומרים על המאפיין target |
תמונות
תמונה היא קישור עם ! לפניו. הטקסט בסוגריים הופך לטקסט החלופי (alt), שקוראי מסך מקריאים בקול.
| רכיב | Markdown | תוצאה |
|---|---|---|
| תמונה |  | <img src="cat.png" alt="A cat asleep on a sofa"> |
| תמונה עם כותרת |  | אותה תמונה עם tooltip במעבר עכבר |
| תמונה מ-URL |  | טוען את התמונה מהרשת |
| תמונה עם קישור | [](https://coddy.tech) | תמונה שפותחת את הקישור בלחיצה |
| תמונה בהפניה | ![Logo][logo]
[logo]: images/logo.png | זהה לתמונה בתוך השורה, כשה-URL מוגדר פעם אחת למטה |
| גודל תמונה | <img src="logo.png" alt="Logo" width="200"> | התמונה, ברוחב 200 פיקסלים. אין ב-Markdown רגיל תחביר לגודל, ולכן זו תגית HTML <img> |
| תמונה ממורכזת | <p align="center">
<img src="logo.png" alt="Logo" width="200">
</p> | תמונה ממורכזת, כמו שרואים בהרבה קבצי README ב-GitHub |
קוד ובלוקי קוד
Backticks מסמנים קוד בתוך שורה; גדר של שלושה backticks מסמנת בלוק. שום דבר בתוך קוד לא מעוצב.
| רכיב | Markdown | תוצאה |
|---|---|---|
| קוד בתוך שורה | Run `npm install` first. | npm install בגופן ברוחב קבוע, כ-<code> |
| Backtick בתוך קוד | ``Use `git` here`` | הקוד Use `git` here. עטפו אותו ביותר backticks ממה שהוא מכיל |
| בלוק קוד | ```
npm install
npm run dev
``` | בלוק, <pre><code>, עם שמירה על ירידות השורה |
| הדגשת תחביר | ```python
def greet(name):
return f"Hello, {name}"
``` | בלוק Python עם תחביר צבעוני. שמות נפוצים: js, ts, python, bash, json, html, css, sql |
| גדר עם טילדות | ~~~js
console.log("hi");
~~~ | זהה לגדר עם backticks |
| קוד מוזח | const total = 42; | בלוק קוד שנוצר מהזחה של 4 רווחים, אחרי שורה ריקה |
| בלוק diff | ```diff
- const x = 1;
+ const x = 2;
``` | ב-GitHub שורות שהוסרו מוצגות באדום ושורות שנוספו בירוק |
| גדר בתוך בלוק | ````markdown
```js
let a = 1;
```
```` | בלוק שמציג את הגדר הפנימית כטקסט. הגדר החיצונית צריכה יותר backticks מהפנימית |
טבלאות
הרחבה של GitHub Flavored Markdown. השורה השנייה, שורת המפריד, הופכת את השורה הראשונה לכותרת. חייב להיות בה אותו מספר תאים כמו בכותרת, אחרת לא נוצרת טבלה.
| רכיב | Markdown | תוצאה |
|---|---|---|
| טבלה | | Name | Role |
| ----- | ------ |
| Ada | Admin |
| Linus | Editor | | טבלה עם שורת כותרת ושתי שורות |
| יישור עמודות | | Left | Center | Right |
| :--- | :----: | ----: |
| a | b | c | | נקודתיים קובעות את היישור: שמאל, מרכז, ימין |
| בלי קווים אנכיים חיצוניים | Name | Role
--- | ---
Ada | Admin | אותה טבלה. הקווים האנכיים בתחילת השורה ובסופה אופציונליים |
| רוחב עמודה | | a | b |
|---|---|
| 1 | 2 | | הרוחב נקבע לפי התוכן. מספר המקפים לא משנה, והקווים האנכיים לא צריכים להיות מיושרים |
| עיצוב בתוך תאים | | Command | Does |
| --- | --- |
| `git status` | Shows **changed** files | | קוד, הדגשה, קישורים ותמונות עובדים כולם בתוך תאים |
| קו אנכי בתוך תא | | Operator | Meaning |
| --- | --- |
| `a \| b` | a or b | | התא מציג a | b. כתבו את הקו האנכי כ-\|, גם בתוך קוד |
| ירידת שורה בתוך תא | | Step | Notes |
| --- | --- |
| 1 | First line<br>Second line | | שתי שורות בתא אחד. ירידת שורה אמיתית הייתה מסיימת את השורה בטבלה |
| מיזוג תאים | <td colspan="2">Both columns</td> | טבלאות Markdown לא יכולות למזג תאים. כתבו את הטבלה ב-HTML עם colspan או rowspan |
ציטוטים
התחילו כל שורה ב->. ציטוט יכול להכיל כל Markdown אחר.
| רכיב | Markdown | תוצאה |
|---|---|---|
| ציטוט | > Simple is better than complex. | ציטוט מוזח, <blockquote> |
| כמה פסקאות | > First paragraph.
>
> Second paragraph. | ציטוט אחד עם שתי פסקאות. השורה עם > בלבד שומרת אותן יחד |
| ציטוט מקונן | > The reply
>> The original message | ציטוט בתוך ציטוט |
| רכיבים אחרים בפנים | > #### Note
> - Back up first
> - Then upgrade | כותרת ורשימה בתוך הציטוט |
| התראה (GitHub) | > [!NOTE]
> Requires Node 20 or later. | תיבת Note צבעונית ב-GitHub. הסוגים האחרים הם [!TIP], [!IMPORTANT], [!WARNING] ו-[!CAUTION] |
קווים אופקיים
שלושה מקפים, כוכביות או קווים תחתונים (או יותר) לבד בשורה מציירים קו לרוחב העמוד.
| רכיב | Markdown | תוצאה |
|---|---|---|
| קו | --- | קו אופקי, <hr> |
| צורות אחרות | ***
___ | עוד שני קווים |
| קו אחרי טקסט | Some text
--- | פסקה, ואחריה קו. שמרו על השורה הריקה |
| שורה ריקה חסרה | Some text
--- | כותרת ברמה 2, לא קו: --- מתחת לשורת טקסט מסמן אותה ככותרת |
הערות שוליים
נתמכות ב-GitHub, ב-GitLab ובהרבה מחוללי אתרים סטטיים. ב-CommonMark קפדני אין הערות שוליים.
| רכיב | Markdown | תוצאה |
|---|---|---|
| הערת שוליים | Markdown dates from 2004.[^1]
[^1]: John Gruber created it, with Aaron Swartz. | ספרה 1 עילית שמקשרת להערה, שמופיעה בתחתית העמוד |
| הערת שוליים עם שם | See the spec.[^spec]
[^spec]: https://spec.commonmark.org | תוויות יכולות להיות מילים, אבל ההערות עדיין ממוספרות 1, 2, 3 לפי סדר השימוש |
| איפה להגדיר אותה | [^1]: The text of the note. | ההגדרה יכולה להופיע בכל מקום בקובץ. היא תמיד מוצגת בסוף |
Escaping של תווים
לוכסן הפוך לפני תו פיסוק מדפיס את התו עצמו במקום עיצוב.
| רכיב | Markdown | תוצאה |
|---|---|---|
| כוכביות מילוליות | \*not italic\* | טקסט רגיל עם הכוכביות: *not italic* |
| סולמית מילולית | \# Not a heading | פסקה שמתחילה ב-# |
| מספר ונקודה | 2024\. A good year. | פסקה, לא רשימה שמתחילה ב-2024 |
| סוגריים מילוליים | \[not a link\](page.md) | הסוגריים המרובעים והעגולים כפי שהוקלדו |
| Backtick מילולי | \` | backtick אחד |
| לוכסן הפוך מילולי | \\ | לוכסן הפוך אחד |
| מה אפשר לסמן ב-escape | \ ` * _ {} [] () <> # + - . ! | | כל סימן פיסוק ב-ASCII. לוכסן הפוך לפני אות או ספרה נשאר לוכסן הפוך |
| ישויות HTML | © 2026 & <div> | © 2026 & <div>, כטקסט |
| אין escaping בתוך קוד | `*stars*` | הקוד *stars* כפי שהוקלד. בתוך קוד לוכסן הפוך הוא תו רגיל |
HTML בתוך Markdown
רוב המרנדרים מעבירים HTML כמו שהוא, כך שתגית מכסה את מה שאין לו תחביר ב-Markdown. GitHub מסיר HTML לא בטוח כמו <script>, <style>, <iframe> ומאפייני style.
| רכיב | Markdown | תוצאה |
|---|---|---|
| מקשי מקלדת | Press <kbd>Ctrl</kbd> + <kbd>C</kbd> | Ctrl ו-C מצוירים כמקשים |
| כתב תחתי ועילי | H<sub>2</sub>O and x<sup>2</sup> | H₂O ו-x² |
| אזור מתקפל | <details>
<summary>Show the answer</summary>
The answer is **42**.
</details> | אזור שנפתח בלחיצה. השורות הריקות מאפשרות ל-Markdown שבתוכו להתרנדר |
| Markdown בתוך בלוק HTML | <div>
**not bold**
</div> | **not bold** כפי שהוקלד. Markdown לא נקרא בתוך בלוק HTML עד ששורה ריקה מסיימת את הבלוק |
| טקסט צבעוני | <span style="color: red">red</span> | טקסט אדום באתרים שמאפשרים סגנונות inline. GitHub מסיר את המאפיין style |
הערות
אין ב-Markdown תחביר להערות. שני טריקים מונעים מטקסט להופיע בעמוד המרונדר.
| רכיב | Markdown | תוצאה |
|---|---|---|
| הערה מוסתרת | [//]: # (This line is never shown) | כלום. השורה היא הגדרת קישור שאף קישור לא משתמש בה, ולכן היא אף פעם לא מגיעה ל-HTML |
| צורה חלופית | [comment]: <> (Also hidden) | כלום, באותו טריק |
| הערת HTML | <!-- TODO: add screenshots --> | כלום בעמוד, אבל ההערה נשארת בקוד המקור של ה-HTML |
| הערה מרובת שורות | <!--
This whole block
is hidden
--> | כלום בעמוד |
| מיקום | Some text.
[//]: # (comment)
More text. | שתי פסקאות. שורת ההערה צריכה שורה ריקה לפניה, אחרת היא מוצגת כטקסט |
GitHub Flavored Markdown ותוספות של GitHub
GitHub Flavored Markdown (GFM) הוא CommonMark בתוספת טבלאות, רשימות משימות, קו חוצה וקישורים מכתובות URL חשופות. GitHub מוסיף עוד מעל זה.
| יכולת | Markdown | איפה זה עובד |
|---|---|---|
| טבלאות | | a | b |
| --- | --- |
| 1 | 2 | | GFM: GitHub, GitLab ורוב כלי התיעוד |
| רשימות משימות | - [x] Done | GFM |
| קו חוצה | ~~text~~ | GFM |
| קישורים מכתובות URL חשופות | www.coddy.tech | GFM |
| קוד עם שפה | ```js
let a = 1;
``` | CommonMark ו-GFM. הצבעים מגיעים מהאתר |
| הערות שוליים | Text.[^1]
[^1]: Note. | GitHub ו-GitLab, אף על פי שזה לא חלק מהמפרט של GFM |
| אימוג'י | :rocket: :tada: | GitHub ו-GitLab הופכים קודים קצרים לאימוג'י |
| אזכורים | @octocat | GitHub: מקשר למשתמש ושולח לו התראה |
| קישורים ל-issues | #123 | GitHub: מקשר ל-issue או ל-pull request מספר 123 באותו מאגר |
| דיאגרמות | ```mermaid
graph LR
A --> B
``` | GitHub ו-GitLab מציירים דיאגרמת Mermaid |
| מתמטיקה | $E = mc^2$
$$
\sum_{i=1}^{n} i
$$ | GitHub מרנדר נוסחאות LaTeX, בתוך השורה בין סימני $ וכבלוק בין שורות $$ |
כל פיסת תחביר של Markdown בעמוד אחד, לצד מה שהיא הופכת להיות. ה-Markdown cheat sheet הזה מכסה את תחביר הליבה (כותרות, הדגשה, ירידות שורה, רשימות, קישורים, תמונות, קוד, ציטוטים) ואת התוספות של GitHub Flavored Markdown: טבלאות עם יישור, רשימות משימות, קו חוצה, קישורים מכתובות URL חשופות והערות שוליים, וגם escaping, HTML והערות.
הדוגמאות עוקבות אחרי CommonMark ו-GitHub Flavored Markdown, הכללים ש-GitHub, GitLab ורוב כלי התיעוד בנויים עליהם. כשאתר מסוים מתנהג אחרת, השורה בטבלה מציינת זאת. כדי לראות כל דוגמה מתרנדרת תוך כדי הקלדה, הדביקו אותה בעורך ה-Markdown.
שאלות נפוצות על ה-Markdown cheat sheet
איך יוצרים טבלה ב-Markdown?
כתבו את שורת הכותרת עם תאים בין קווים אנכיים, אחריה שורת מפריד של מקפים, ואז שורה אחת לכל שורה בטבלה:
| Name | Role |, | --- | --- |, | Ada | Admin |. נקודתיים בשורת המפריד מיישרות עמודה: :--- לשמאל, :---: למרכז, ---: לימין. טבלאות הן יכולת של GitHub Flavored Markdown, ולכן הן עובדות ב-GitHub, ב-GitLab וברוב כלי התיעוד, אבל לא ב-CommonMark קפדני.איך יורדים שורה ב-Markdown?
ירידת שורה בודדת בתוך פסקה לא מופיעה בפלט. כדי לכפות ירידת שורה, סיימו את השורה בשני רווחים או בלוכסן הפוך (
\), או כתבו <br>. כדי להתחיל פסקה חדשה, השאירו שורה ריקה. ה-issues והתגובות של GitHub הם היוצא מן הכלל: שם ירידת שורה בודדת כבר מוצגת כירידת שורה.איך כותבים הערה ב-Markdown?
אין ב-Markdown תחביר להערות, אבל שני טריקים עובדים.
[//]: # (your comment) בשורה נפרדת, עם שורה ריקה לפניה, הוא הגדרת קישור שאף אחד לא משתמש בה, ולכן היא אף פעם לא מגיעה לעמוד או ל-HTML. הערת HTML, <!-- your comment -->, גם היא מוסתרת בעמוד אבל נשארת בקוד המקור של ה-HTML, שבו כל מי שצופה בקוד המקור יכול לקרוא אותה.איך יוצרים בלוק קוד ב-Markdown?
שימו שלושה backticks בשורה שלפני הקוד ושלושה בשורה שאחריו. הוסיפו שם של שפה אחרי ה-backticks הפותחים, כמו ב-
```python, כדי לקבל הדגשת תחביר. לקוד בתוך משפט, עטפו אותו ב-backticks בודדים: `npm install`.איך מוסיפים תיבת סימון ב-Markdown?
התחילו פריט ברשימה ב-
[ ] לתיבה ריקה או ב-[x] לתיבה מסומנת: - [ ] Review או - [x] Draft. שמרו על הרווח בתוך הסוגריים הריקים. תיבות סימון הן חלק מ-GitHub Flavored Markdown, וב-issues וב-pull requests של GitHub אפשר לסמן אותן בלחיצה.איך משנים את הגודל של תמונה ב-Markdown?
אין ב-Markdown רגיל תחביר לגודל:
 תמיד מציג את התמונה בגודל המקורי שלה. השתמשו במקום זאת בתגית HTML, כמו <img src="image.png" alt="alt text" width="300">, ש-GitHub ורוב המרנדרים מקבלים. הגדירו רק את הרוחב או רק את הגובה כדי לשמור על הפרופורציות.איך מקשרים לכותרת ב-Markdown?
קשרו למזהה של הכותרת עם
#: [Setup](#getting-started) קופץ אל ## Getting Started. GitHub בונה את המזהה מטקסט הכותרת באותיות קטנות, כשרווחים הופכים למקפים וסימני פיסוק מלבד מקפים וקווים תחתונים מוסרים. לכותרת בקובץ אחר, שימו את המזהה אחרי שם הקובץ: [Setup](docs/install.md#getting-started).מה זה קובץ .md?
קובץ טקסט רגיל שכתוב ב-Markdown.
.md ו-.markdown הן הסיומות המקובלות, ו-README.md הוא הקובץ ש-GitHub מציג בעמוד הראשי של מאגר. כל עורך טקסט יכול לפתוח אותו; GitHub, אתרי תיעוד ומציגי Markdown מרנדרים אותו כטקסט מעוצב. כדי לראות קובץ מתרנדר תוך כדי עריכה, הדביקו אותו בעורך ה-Markdown.משאבים קשורים
עוד דפי עזר
