- Markdown מאפשר לך לעצב במהירות טקסט רגיל ב-GitHub וב-Reddit עם תחביר קל וקל לזכירה.
- GitHub Flavored Markdown מוסיף טבלאות, רשימות מטלות, התראות, הערות שוליים וניווט מתקדם בין מדורים.
- Reddit משתמשת ב-Snoomark, גרסה של Markdown הדומה לזו של GitHub אך עם תכונות כמו ספוילרים ודרך שונה של טיפול בתמונות.
- שליטה בכותרות, רשימות, ציטוטים, קוד, קישורים ותמונות משפרת באופן דרמטי את הקריאות והיעילות של כל תוכן בשתי הפלטפורמות.
אם אתם כותבים לעתים קרובות ב-GitHub או מבלים זמן רב ברדיט, שליטה ב- Markdown היא אחד הדברים שחוסכים לכם שעות ומקלים על חייכם. זוהי שפת סימון קלת משקל מאוד המאפשרת לכם לעצב טקסט רגיל במהירות מבלי להתקשות בתפריטים או כפתורים, רק עם כמה סמלים הממוקמים במקומות הנכונים.
ב-GitHub תמצאו את זה בכל מקום: במאגר קבצי README.md , בבעיות, בבקשות משיכה, בדיונים ואפילו בפרופיל שלכם. Reddit, לעומת זאת, משתמש בגרסה בשם Snoomark (בסגנון Reddit Markdown) שיורשת חלק ניכר מהתחביר של GitHub, עם כמה תכונות ומגבלות ייחודיות. בואו נראה, שלב אחר שלב ועם שפע של דוגמאות, כיצד להשתמש ב-Markdown ב-GitHub וב-Reddit במהירות ומבלי לפספס שום דבר חשוב.
מה זה Markdown ולמה הוא כל כך שימושי ב-GitHub וב-Reddit?
Markdown היא שפת סימון קלת משקל שנועדה להפוך טקסט רגיל לקל לקריאה וכתיבה, ובמקביל לאפשר המרה קלה ל-HTML. בפועל, משמעות הדבר היא שניתן לכתוב טקסט רגיל ולהוסיף כמה תווים מיוחדים כדי ליצור כותרות, רשימות, טבלאות, ציטוטים, קוד מעוצב, קישורים או תמונות.
ב-GitHub, המימוש בו נעשה שימוש הוא GitHub Flavored Markdown (GFM), אשר מרחיב את התחביר הקלאסי עם טבלאות, רשימות מטלות, הדגשת קוד מתקדמת, תמיכה בצבעים, התראות וכמה תגי HTML מותרים. כל זה מוצג אוטומטית בקבצי .md ובשדות התגובות של הפלטפורמה.
Reddit משתמש בעורך משלו בשם Snoomark, נגזרת של GFM. הוא חולק חלק ניכר מההתנהגות הבסיסית (מודגש, נטוי, כותרות, רשימות, ציטוטים, קוד מוטבע או קוד בלוק, קישורים וכו'), אך יש לו ייחודיות חשובה : לדוגמה, תמיכה בתמונות מוגבלת יותר בהתאם להקשר, והוא מוסיף אלמנטים משלו כמו ספוילרים.
היופי בכל זה הוא שעם תחביר יחיד, ניתן לכתוב טקסטים שנראים טוב גם ב-GitHub וגם ברדיט, תוך התאמת פרטים בודדים בלבד כאשר כל פלטפורמה פועלת בצורה שונה. לימוד הכללים הבסיסיים מאפשר לנווט בשניהם בקלות מבלי ללמוד מחדש דבר מאפס.
כותרות ומבנה תוכן
אחד הדברים הראשונים שתשתמשו בהם הם כותרות , גם ב-GitHub וגם ברדיט. הן עוזרות לבנות את הטקסט לסעיפים ותתי-סעיפים.
ב-Markdown, כותרת נוצרת על ידי הוספת סימני גיבוב אחד עד שישה לפני הטקסט: אחד עבור כותרת ברמה 1, שניים עבור רמה 2, וכן הלאה עד רמה 6. לדוגמה, בקובץ GitHub README.md ייתכן שיהיה משהו כמו: # Main Title , ## Section , ### Subsection , וכו'.
כאשר GitHub מוצא שתי כותרות או יותר בקובץ, הוא יוצר אוטומטית תוכן עניינים הנגיש דרך סמל ה"מתווה" בראש הקובץ. כל כותרת מופיעה כקישור שמעביר אותך ישירות לקטע זה, וזה נהדר עבור מסמכים ארוכים.
בנוסף, כל כותרת הופכת לעוגן פנימי שניתן לקשר אליו באמצעות קטע URL המבוסס על טקסט הכותרת. כדי ליצור את הקטע הזה, GitHub מיישם כללים ספציפיים מאוד: הוא ממיר אותיות לאותיות קטנות, מחליף רווחים במקפים, מסיר סימני פיסוק ועיצוב (כגון נטוי), גוזם רווחים עודפים, ואם התוצאה תואמת כותרת קודמת אחרת, מוסיף סיומת מספרית (-1, -2 וכו') כדי להפוך אותה לייחודית.
זה מאפשר לך לעשות דברים כמו להציב קטע דוגמה ואז לקשר אליו מנקודה אחרת במסמך עם קישור כמו (#sample-section) , או אפילו לקשר לקטעים עם תווים מיוחדים בכותרת, מכיוון ש-GitHub מייצר את הקטע לפי כללים אלה והופך אותו לנגיש עם אותה תבנית.
הדגשות, טקסט מודגש וציטוטים
Markdown מאפשר לך להדגיש טקסט באמצעות צורות שונות של הדגשה : מודגש, נטוי, קו חוצה, כתב תחתי, כתב עילי או קו תחתון. ב-GitHub, טבלת הסגנונות האופיינית תיראה בערך כך, למרות שסיכמנו אותה כאן במונחים שונים:
כדי להדגיש את הטקסט , הקיפו אותו בכוכביות כפולות או בקו תחתון כפול; עבור כתב נטוי, השתמשו בכוכביות בודדות או בקו תחתון; כדי להדגיש את הטקסט, השתמשו בטילדה כפולה (שתי טילדות) משני צידי הטקסט. ניתן גם לשלב אותיות מודגשות וכתב נטוי מקוננות, להשתמש בשלוש כוכביות כדי להחיל את שתיהן על קטע טקסט שלם, או להשתמש בתגיות HTML כמו `<b>` עבור כתב תחתון ועילי, ו-`<i>` עבור קווים תחתונים.
גיטהאב מאפשר גם ליצור ציטוטים מסוג blockquote על ידי הצבת סימן גדול מ-(>) בתחילת השורה. הטקסט המצוטט מוצג עם פס אנכי משמאל ובאפור, מה שמבליט אותו בצורה ברורה. ניתן לכלול מספר שורות באותו blockquote, ואפילו לקינן ציטוטים על ידי הוספת סימנים נוספים של > בתחילת השורה.
צורת ציטוט מתקדמת ייחודית ל-GitHub היא התראה או האזהרה . היא משתמשת באותו תחביר של ציטוט, אך השורה הראשונה כוללת סמן מיוחד לציון סוג ההתראה. לדוגמה, ניתן לציין `התראה` עבור מידע שימושי, `טיפים מועילים`, `נתונים מרכזיים`, `אזהרות דחופות` ו-`אזהרות מפני סיכונים או השלכות שליליות`. GitHub מציג כל סוג עם צבע וסמל שונים, המסייעים להדגיש מידע קריטי בתיעוד שלך.
Reddit תומך גם בציטוטים פשוטים עם אותו סמל >, למרות שחסרה לו מערכת הפינג העשירה של GitHub. למרות זאת, זוהי עדיין דרך שימושית מאוד להגיב למישהו על ידי ציטוט חלק מההודעה שלו מבלי לחזור עליה במלואה.
הדגשת קוד, בלוקים וצבעים
גם GitHub וגם Reddit מאפשרים לך להדגיש קטעי קוד בתוך טקסט באמצעות backticks. עבור קוד מוטבע, אתה סוגר את המילה או הפקודה עם backtick יחיד מכל צד. זה אידיאלי להדגשת, למשל, ` git status` בתוך משפט, מה שמבהיר שמדובר בפקודה.
כאשר רוצים בלוק קוד עצמאי, Markdown משתמש בשלושה backticks: כותבים שורה עם שלושה backticks, לאחר מכן את הקוד בשורות נפרדות, וסוגרים עם שלושה backticks נוספים. ב-GitHub, אם מציינים גם את השפה מיד לאחר backticks הראשונים, מוחל הדגשת תחביר עם צבעים ועיצוב ספציפיים לשפה זו.
גיטהאב מציע גם תכונה ספציפית להדגשת ערכי צבע בתוך קודים אחוריים. אם מקלידים צבע בפורמט הקסדצימלי, RGB או HSL בין קודים אחוריים, הפלטפורמה כוללת מחוון צבע קטן ליד הטקסט. לדוגמה, אם צבע הרקע במצב בהיר הוא #ffffff ובמצב כהה הוא #000000, הדגשת קודים אלה מאפשרת לראות במהירות איזה הוא איזה.
בנוגע לתצוגת קוד וטבלאות, GitHub מאפשר לך להפעיל גופן חד-מרחבי קבוע בכל שדות התגובות, מה שמקל על העבודה עם טקסט טכני. אם אתה עורך הרבה קטעי קוד בדפדפן שלך או בעורכים כמו Visual Studio Code , הפעלת אפשרות זו הופכת את היישור והקריאה לעקביים הרבה יותר.
Reddit תומך גם בבלוקים של קוד עם backticks, הן inline והן block, אם כי השימוש בהם שם מתמקד יותר בקטעי קוד קטנים או פסאודו-קוד מאשר בתיעוד ארוך כמו זה של מאגר.
יצירת קישורים ב-Markdown היא פשוטה מאוד: אתם סוגרים את הטקסט שיוצג למשתמש בסוגריים מרובעים ואת כתובת ה-URL בסוגריים. זה עובד גם ב-GitHub וגם ברדיט, וניתן לשפר זאת באמצעות קיצורי מקלדת ב-GitHub (לדוגמה, שימוש בשילובי מקשים כדי להמיר במהירות טקסט נבחר לקישור).
GitHub מוסיף כמה תכונות נוספות הקשורות לניווט. ראשית, הוא מאפשר קישור ישיר לכותרות באמצעות כללי יצירת קטעי הקוד שנדונו קודם לכן. שנית, הוא תומך בקישורים יחסיים בתוך המאגר עצמו, דבר חיוני לתיעוד טכני.
קישור יחסי הוא קישור המחושב באמצעות הקובץ הנוכחי כמקור. לדוגמה, אם קובץ ה-README שלך נמצא בשורש הפרויקט ואתה רוצה לקשר לקובץ docs/CONTRIBUTING.md, אתה פשוט כותב קישור עם הנתיב docs/CONTRIBUTING.md. GitHub מטפל בתרגום נכון של קישור יחסי זה בכל ענף שאתה נמצא בו, ומונע ממנו להישבר בעת מעבר בין ענפים או שכפול המאגר.
ההמלצה היא תמיד להשתמש בנתיבים יחסיים בעת ניווט בין קבצים באותו מאגר, מכיוון שקישורים מוחלטים עלולים להפסיק לעבוד בשכפולים או בפיצולים. GitHub מאפשר שימוש באופרטורים סטנדרטיים כמו ./ או ../ ובנתיבים המתחילים ב- / יחסית לשורש הפרויקט.
אם ברצונך ליצור נקודות עיגון מותאמות אישית בתוך מסמך מעבר לכותרות, תוכל להשתמש בתגיות HTML עם המאפיין `name`. זה מאפשר לך למקם נקודת יעד באמצע פסקה או ליד טקסט שאין לו כותרת משלו, ולקשר אליה באמצעות אותו תחביר כמו עבור כותרות שנוצרות אוטומטית.
תמונות ב-GitHub: Markdown, HTML ונתיבים יחסיים
ב-GitHub, תמונות מוטמעות בדרך כלל באמצעות אותו תחביר כמו קישורים, אך לפניהן סימן קריאה. הטקסט החלופי (alt) מצוין בתוך סוגריים מרובעים, וכתובת האתר או הנתיב לתמונה ממוקמים בתוך סוגריים. טקסט חלופי זה חשוב לנגישות , מכיוון שזה מה שקוראי מסך יקראו ומה יוצג אם התמונה לא תטען.
תמונות יכולות להגיע מקבצים בתוך המאגר עצמו או מכתובות URL חיצוניות. GitHub מאפשר מספר דפוסי נתיב יחסיים להעלאת תמונות מענפים שונים, מאגרים אחרים, או אפילו בעיות והערות, תוך שימוש בסיומות כמו ?raw=true כדי לאלץ הורדה ישירה של הקובץ בעת הצורך.
בנוסף לתחביר הסטנדרטי של Markdown, GitHub תומך בשימוש באלמנט HTML `<picture>`. אלמנט זה שימושי במיוחד לטעינת תמונות רספונסיביות המשתנות בהתאם להעדפות העיצוב של המשתמש (בהיר או כהה). באמצעות שאילתת המדיה `prefers-color-scheme`, ניתן להגדיר מקורות תמונה שונים עבור כל מצב, ותמונת ברירת מחדל עבור דפדפנים שאינם תומכים בתכונה זו.
הדפוס הטיפוסי כרוך בהכללה בתוך מספר אלמנטים עם תכונות המדיה וה-srcset שלה, ולבסוף א באמצעות המאפיין alt וכתובת URL כללית, משתמשים במצב כהה רואים תמונה מותאמת, בעוד שאלו במצב בהיר מקבלים תמונה שונה, מבלי שיהיה צורך לשכפל תוכן בקובץ README.
GitHub תומך גם בתגובות HTML בקבצי Markdown, מה שמאפשר להוסיף תזכורות בלתי נראות לקורא, למשל כדי להזכיר לו לעדכן קטע תמונה או להוסיף דוגמאות חדשות בהמשך.
טבלאות, חלקים מתקפלים והפרדת תוכן
אחד השיפורים השימושיים ביותר ב-GitHub Flavored Markdown הוא התמיכה בטבלאות . ניתן לארגן נתונים בשורות ובעמודות באמצעות פסים אנכיים להפרדת תאים ושורת מקפים לסימון הכותרת. ניתן גם ליישר עמודות לימין, לשמאל או למרכז באמצעות נקודתיים בשורת ההפרדה.
טבלאות שימושיות מאוד להצגת רשימות של שפות תכנות, מסגרות (frameworks) שבהן נעשה שימוש, משימות מתוכננות, השוואות תכונות או כל מידע אחר שנהנה ממבנה מטריצה. GitHub מעבד טבלאות אלו בסגנון נקי וקריא.
כדי לשמור על סדר בקובץ README ארוך, ניתן להשתמש בתג HTML `<details>` כדי ליצור מקטעים הניתנים לקיפול. מקטעים אלה מציגים סיכום בתוך התג `<summary>` ומאפשרים למשתמש להרחיב או לכווץ תוכן נוסף לפי הצורך. מקובל לכלול טבלאות או בלוקים של מידע משני בתוך `<details>` כדי למנוע עומס יתר על המשתמש במבט ראשון.
אם ברצונך שהקטע יופיע מורחב כברירת מחדל, פשוט הוסף את התכונה open ל- טכניקה זו פרקטית מאוד לקיבוץ דירוגים, רשימות ארוכות או תוכן שאינו חיוני לקריאה ראשונה אך נוח שיהיה נגיש.
כלי פשוט נוסף לארגון מידע הוא הכלל האופקי. הוא נוצר על ידי כתיבת שלושה מקפים או יותר על קו ומשמש לציור קו הפרדה בין סעיפים, המאפשר לך להפריד בבירור, למשל, בין סעיף תיאורי לסעיף של הפניות או הערות נוספות.
ניתן לשלב כללים אלה עם ציטוטים בסוף המסמך כדי להדגיש ביטויים מעוררי השראה, תזכורות או מסרים מרכזיים. דוגמה אופיינית תהיה הצבת ציטוט מוטיבציוני בסוף קובץ ה-README של הפרופיל שלך, מעוצב עם ציטוט בלעדי אחרי קו מפריד.
הערות נסתרות ובקרת עיצוב
GitHub מאפשר לך להוסיף הערות HTML בתוך Markdown באמצעות התחביר <!-- comment -->. כל דבר שתכניס לתוך הערה זו לא יוצג בתוכן המעובד, אך יהיה גלוי בקוד המקור, מה שהופך אותו לאידיאלי עבור הערות פנימיות או משימות.
לדוגמה, בקובץ README של הפרופיל ניתן להוסיף הערה שאומרת משהו כמו שצריך להרחיב את הקטע "אודותיי" מאוחר יותר או שצריך לעיין בטבלה של טכנולוגיות מיושנות, מבלי שאף אחד שמבקר בפרופיל יראה זאת ישירות.
תכונה שימושית נוספת היא תווים מסוג escape שבדרך כלל יתפרשו כ-Markdown. אם עליך להציג כוכביות, סמלי גיבוב או סמלים אחרים פשוטו כמשמעו מבלי שהם יעוצבו, פשוט הוסף קו נטוי הפוך לפני כל אחד מהם. זה מאפשר לך, לדוגמה, לכתוב ביטויים הכוללים סמלי רשימה מבלי להמיר אותם לרשימות בפועל.
כשאתם צופים בקובץ סימון ב-GitHub, יש לכם אפשרות לעבור בין התצוגה המעובדת לקוד המקור באמצעות כפתור בחלק העליון (או לפתוח אותו בעורכים כמו Brackets ). השבתת פירוש Markdown מאפשרת לכם גישה לתכונות תצוגת קוד אופייניות כמו קישור שורות ספציפיות , דבר שימושי מאוד כשרוצים לסמן קטע מדויק של קובץ README או כל קובץ .md.
לבסוף, זכרו ש-GitHub מטפל במעברי שורה בצורה שונה בתגובות (בעיות, הודעות פרטיות וכו') ובקבצי .md. בתגובות, מעברי שורה מטופלים ישירות, בעוד שבקבצי Markdown יש להוסיף שני רווחים בסוף השורה, קו נטוי הפוך או נקודה. כדי לאלץ את הקפיצה בתוך אותה פסקה.
רשימות, רשימות מקוננות ורשימות מטלות
רשימות הן אחד האלמנטים הנפוצים ביותר ב-Markdown, הן ב-GitHub והן ב-Reddit. ניתן ליצור רשימות לא מסודרות על ידי הוספת מקף, כוכבית או סימן פלוס לפני כל פריט ברשימה. כל הסמנים הללו מוצגים באופן דומה לנקודות תבליט.
כדי ליצור רשימות מסודרות , יש למספר כל שורה במספר ואחריו נקודה ורווח. אמנם סדר המספרים אינו חייב להיות מושלם (GitHub בדרך כלל מחשב אותו מחדש), אך מומלץ לשמור על מספור עקבי כדי לשמור על קוד המקור קריא.
רשימות מקוננות נוצרות פשוט על ידי הזחה של הפריטים שמתחתן. בעורכים בעלי מרווחים חד-פעמיים כמו Sublime Text , כל שעליכם לעשות הוא ליישר חזותית את סמני הרשימה המקוננת מתחת לתו הראשון של הטקסט בפריט האב. בהקשרים כמו עורך התגובות של GitHub, שבהם הגופן אינו בעל מרווחים חד-פעמיים, עליכם לספור כמה תווים נמצאים לפני הטקסט ולהשתמש במספר רווחים זה עבור ההזחה.
ניתן גם לבנות מספר רמות של קינון, כל עוד שומרים על עקביות במספר הרווחים. עבור רשימות מורכבות מאוד, שיטה זו דורשת מעט תרגול, אך ברגע שמשתלטים עליה, היא מהירה מאוד ליישום.
GitHub מציע גם רשימות משימות , שהן שימושיות מאוד עבור בעיות, בקשות משיכה ותיעוד. אלה נוצרות על ידי הוספת מקף, רווח וזוג סוגריים מרובעים עם רווח או "x" בפנים לפני הרשימה: אחת עבור משימות ממתינות ואחת עבור משימות שהושלמו. רשימות אלו מוצגות עם תיבות סימון שניתן לבחור או לבטל את הבחירה מהממשק.
אם הטקסט של פריט ברשימת מטלות מתחיל בסוגריים, יש לסמן אותו באמצעות קו נטוי הפוך כדי למנוע בלבול במנתח. זהו פרט קטן, אך חשוב בעת כתיבת תיאורים שמתחילים במשהו כמו "(אופציונלי)" או דומה.
אזכורים, הפניות ואמוג'ים ב-GitHub
אחד היתרונות של כתיבה ב-Markdown ב-GitHub הוא היכולת להשתמש באזכורים ישירים של משתמשים וצוותים בפלטפורמה. פשוט מקלידים @ ואחריהם שם המשתמש או שם הצוות, ו-GitHub שולח הודעה לחשבון זה, ומפנה את תשומת ליבו לשיחה.
כשמקישים את הסימן @, GitHub מציג רשימה של משתמשים וצוותים המשויכים למאגר או לשרשור, וניתן לסנן רשימה זו תוך כדי הקלדה. השתמשו במקשי החצים והקישו Enter או Tab כדי לקבל את ההצעות. עבור צוותים, השתמשו בפורמט @organization/team-name, וכל חברי הצוות יהיו רשומים לשרשור.
בנוסף לאזכורים, GitHub מאפשר הפניה קלה לבעיות ולבקשות משיכה פשוט על ידי הקלדת # ואחריה מספר או חלק מהכותרת. מופיעה רשימה של תוצאות מוצעות, אותן ניתן להשלים באותו אופן כמו אזכורים. זה מאיץ מאוד את הניווט בין שיחות קשורות.
אם במאגר שלך מוגדרות הפניות מקושרות אוטומטית מותאמות אישית, ייתכן שגם סימונים חיצוניים מסוימים (כגון מזהי כרטיסי JIRA או Zendesk) יומרו אוטומטית לקישורים קצרים. הגדרה זו דורשת הרשאות ניהול, אך לאחר הפעלתה, היא מאפשרת שיתוף נתונים בין-מערכות במאמץ מינימלי.
לבסוף, GitHub תומך באימוג'ים באמצעות קוד: הקלד נקודתיים, ואחריהם שם האימוג'י, וסיימו בנקודתיים נוספים. כשמתחילים להקליד, מופיעה רשימה של הצעות, אותן ניתן לאשר באמצעות Tab או Enter. שילוב אימוג'ים בתגובות שלך עוזר להן להעניק מגע אנושי יותר, כל עוד לא משתמשים בהם יתר על המידה בתיעוד רשמי.
הערות שוליים ותוכן מתקדם
גיטהאב תומך גם בהערות שוליים באמצעות תחביר מבוסס סוגריים ומזהה עם תו caret. בנקודה שבה רוצים את ההפניה, מוסיפים משהו כמו `<footnote>`, ובסוף המסמך מגדירים את הטקסט של הערת השוליים עם אותו תג, ואחריו נקודתיים ותוכן.
הערות שוליים יכולות להשתרע על פני מספר שורות, וכדי לאלץ מעברי שורה בתוך הערת שוליים, משתמשים ברווחים כפולים בסוף השורה, בדיוק כמו בגוף ה-Markdown. בעת הרינדור, GitHub מציג כתב עילי על הטקסט ורשימת הערות שוליים בסוף, עם קישורים נכנסים לניווט בין הפניות והערות שוליים.
תכונה מתקדמת נוספת שמציע GitHub היא ההתראות שהוזכרו קודם לכן (הערה, טיפ, חשוב, אזהרה ו-Caution). מומלץ להשתמש בהן רק כאשר באמת נחוץ ולהימנע משרשור של יותר מדי התראות יחד כדי למנוע עומס על הקורא. לא ניתן לקנן אותן בתוך אלמנטים מורכבים אחרים, לכן תכנון קפדני חיוני למיקומן.
לבסוף, ניתן לבקש מ-GitHub להסתיר באופן זמני קטעים של Markdown שעברו רינדור על ידי עטיפתם בתוך הערות HTML, או להתעלם מעיבוד של תווים מסוימים באמצעות קוים נטויים לאחור. זה שימושי במיוחד כשמתעדים את תחביר Markdown עצמו וצריכים להציג דוגמאות כפי שהוא, ללא פרשנות.
Markdown ברדיט: Snoomark ומצב עריכה
Reddit היא פלטפורמת דיון שבה כמעט כל נושא מתקבל בברכה, מאורגנת ב-subreddits. מבחינת עיצוב, היא מציעה שני עורכים: אחד לטקסט עשיר ויזואלי יותר, ואחר לטקסט רגיל המבוסס על Markdown. אם אתם רוצים לעבוד במהירות ולשלוט היטב בתוצאה, תרצו להשתמש באפשרות Markdown.
כברירת מחדל, Reddit בדרך כלל מפעיל את עורך הטקסט העשיר, כך שכדי לעבור למצב סימון עליכם ללחוץ על האפשרות מצב סימון בתוך תיבת הטקסט של פוסט או תגובה. משם, תוכלו להשתמש בתחביר Snoomark ישירות.
אם אתם מעדיפים שעורך Markdown ייטען תמיד, גשו להגדרות המשתמש שלכם, הזינו את הקטע "הגדרות הזנה" והפעילו את האפשרות "ברירת מחדל ל-Markdown" . בדרך זו, עורך Markdown ייפתח אוטומטית בכל פעם שתתחילו לכתוב פוסט או תגובה, מבלי שתצטרכו לשנות זאת ידנית.
Reddit תומך ברוב תכונות Markdown הבסיסיות והמתקדמות: כותרות, אותיות מודגשות ונטויות, רשימות, ציטוטים, בלוקי קוד, קישורים וכמה תוספות משלו כמו ספוילרים. עם זאת, יש לו חסרונות משמעותיים בהשוואה ל-GitHub, במיוחד בטיפול בתמונות , שתלוי מאוד בהקשר ובסוג העורך.
תחביר נתמך על ידי Reddit וספוילרים
גרסת Snoomark שבה משתמש Reddit כוללת אלמנטים רבים במשותף עם GitHub, כך שאם אתם כבר בקיאים ב-Markdown עבור מאגרים, העברת הידע הזה לסביבת Reddit היא די פשוטה. אתם יכולים להשתמש בכותרות כדי לבנות פוסטים ארוכים, רשימות ממוספרות או עם תבליטים, ציטוטים כדי להשיב למשתמשים אחרים, ובלוקים של קוד כשתרצו להציג פקודות או קטעי טקסט טכניים.
אחד ההבדלים הבולטים הוא האופן שבו Reddit מטפלת בתמונות . למרות שבמקרים רבים תמונות מועלות דרך הממשק הגרפי ולא ישירות באמצעות תחביר Markdown, המנוע שמעבד את תוכן הטקסט הוא עדיין Snoomark, כך שהעיצוב סביב תמונות אלו אכן מבוסס על Markdown.
Reddit, לעומת זאת, מוסיפה תכונות נוספות שאינן כלולות במפרט הסטנדרטי, כגון ספוילרים. אלה מאפשרים להסתיר טקסט מאחורי שכבה שהמשתמש יכול לחשוף בלחיצה. מבחינה טכנית, כאשר Reddit מעבד ספוילר, הוא הופך אותו לשילוב של HTML, מחלקות CSS ו-JavaScript ספציפי לפלטפורמה.
ייצוג ה-HTML המתקבל של ספוילר כולל מטפלים השולטים מתי להציג או להסתיר את התוכן, ובעוד שתיאורטית ניתן לכתוב משהו דומה עם HTML רגיל, ב-Reddit זה תלוי ביישום הפנימי שלו. הדבר החשוב עבורך כמשתמש הוא שכאשר אתה כותב, אתה צריך להשתמש רק בתחביר הספוילרים הספציפי שמספק העורך, ו- Snoomark דואג לתרגם אותו למבנה המתאים.
בקיצור, Snoomark יורש התנהגויות רבות מ-GitHub Flavored Markdown, אך מכוון לצרכים של קהילת דיון ולא לתיעוד הפרויקט. למרות זאת, הליבה נשארת זהה: טקסט רגיל עם סמלים פשוטים שהופכים לתוכן מובנה וקריא.
שליטה בתחביר Markdown ב-GitHub וב-Reddit הופכת את כתיבת התיעוד הטכני, פתיחת נושאים מוסברים היטב, השארת הערות ברורות בבקשות משיכה והשתתפות בדיונים ב-Reddit ליעילים הרבה יותר. בעזרת כמה כללים מרכזיים - כותרות, הדגשות, רשימות, ציטוטים, בלוקי קוד, קישורים, תמונות וטריקים ספציפיים כמו טבלאות, פרטים מתקפלים, התראות, הערות שוליים וספוילרים - תוכלו לעבור מכתיבת הודעות תפלות ליצירת תוכן נקי, ניתן לסריקה ומקצועי מבלי ללחוץ על כפתור עכבר אחד.
