דלג לתוכן הראשי

גברת Markdown

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

1. כותרות (Headings)​

ניתן להוסיף כותרות ברמות שונות (H1-H6) בעזרת סימני סולמית (#). מספר הסולמיות קובע את רמת הכותרת.

# כותרת ראשית (H1)
## כותרת משנית (H2)
### כותרת תת-משנית (H3)
#### כותרת רביעית (H4)
##### כותרת חמישית (H5)
###### כותרת שישית (H6)

2. פסקאות (Paragraphs)​

פסקאות נכתבות באופן פשוט על ידי כתיבת טקסט רגיל. כדי להוסיף פסקה חדשה, יש להשאיר שורה ריקה בין הפסקאות.

זוהי פסקה ראשונה.

זוהי פסקה שנייה.

3. טקסט מודגש ונטוי (Bold & Italic)​

Markdown מאפשר להדגיש טקסט (Bold) ולהטות טקסט (Italic) בעזרת תווים מיוחדים.

  • טקסט נטוי: השתמשו בכוכבית אחת (*) או בקו תחתון אחד (_) מכל צד של המילה.
*טקסט נטוי* או _טקסט נטוי_
  • טקסט מודגש: השתמשו בשתי כוכביות (**) או שני קווים תחתונים (__).
**טקסט מודגש** או __טקסט מודגש__
  • מודגש ונטוי יחד: השתמשו בשלוש כוכביות או שלושה קווים תחתונים.
***טקסט מודגש ונטוי***

4. רשימות (Lists)​

Markdown מאפשר יצירת רשימות לא ממוספרות (bulleted lists) ורשימות ממוספרות (ordered lists).

  • רשימה לא ממוספרת: השתמשו בכוכבית (*), מקף (-), או פלוס (+).
* פריט ראשון
* פריט שני
    * תת-פריט
  • רשימה ממוספרת: השתמשו במספרים ואחריהם נקודה.
1. פריט ראשון
2. פריט שני
    1. תת-פריט

ליצירת קישורים, השתמשו בסוגריים מרובעים לטקסט הקישור ובסוגריים עגולים לכתובת ה-URL.

[GitHub](https://github.com)

6. תמונות (Images)​

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

![Alt Text](https://example.com/image.jpg)

7. ציטוטים (Blockquotes)​

ניתן ליצור ציטוטים בעזרת סימן > בתחילת כל שורה.

> זהו ציטוט.

8. קוד (Code)​

  • קוד בתוך טקסט: השתמשו ב-backticks (```) כדי להציג קוד בתוך שורה.
זוהי פקודת `git status`.
  • בלוק קוד: כדי להוסיף בלוק קוד (מובנה), השתמשו בשלושה backticks.

` ` `
function sayHello() {
    console.log("Hello, World!");
}
` ` `

או לציין את השפה:

` ` `javascript
function sayHello() {
    console.log("Hello, World!");
}
` ` `

9. הוספת טבלאות (Tables)​

Markdown מאפשר יצירת טבלאות פשוטות.

| כותרת 1 | כותרת 2 |
|---------|---------|
| תוכן 1  | תוכן 2  |
| תוכן 3  | תוכן 4  |

10. הוספת הערות שוליים (Footnotes)​

Docusaurus תומך בהוספת הערות שוליים עם סיומת Markdown. הנה הדרך להוספה:

זוהי דוגמה להערת שוליים[^1].

[^1]: זו ההערה עצמה שתופיע בתחתית המסמך.

11. כפתורים מותאמים אישית (Custom Buttons - Docusaurus בלבד)​

ב-Docusaurus, ניתן להוסיף כפתורים בצורה מותאמת אישית באמצעות התחביר הבא:

import Link from '@docusaurus/Link';

<Link
  className="button button--primary button--lg"
  to="https://github.com">
  בואו לגיטאהב
</Link>

12. תוכן עניינים אוטומטי (Auto Table of Contents - Docusaurus בלבד)​

ב-Docusaurus, ניתן ליצור תוכן עניינים אוטומטי בעזרת התחביר הזה:

## Table of Contents
- [הקדמה](#הקדמה)
- [כותרת ראשונה](#כותרת-ראשונה)