כיצד להשתמש במהירות ב-Markdown ב-GitHub וב-Reddit

אינפורמטק דיגיטל » Recursos » כיצד להשתמש במהירות ב-Markdown ב-GitHub וב-Reddit

אם אתם כותבים באופן קבוע ב-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 ייתכן שיהיה משהו כמו: # כותרת ראשית, ## סעיף, סעיף קטן, וכו '

כאשר GitHub מוצא שתי כותרות או יותר בקובץ, הוא יוצר אוטומטית... תוכן העניינים נגיש דרך סמל "מתווה" בראש הקובץ. כל כותרת מופיעה כקישור שמעביר אותך ישירות לקטע זה, וזה נהדר עבור מסמכים ארוכים.

בנוסף, כל כותרת הופכת לעוגן פנימי שניתן לקשר אליו באמצעות קטע URL המבוסס על טקסט הכותרת. כדי ליצור את הקטע הזה, GitHub מיישם כללים ספציפיים מאוד: הוא ממיר אותיות לאותיות קטנות, מחליף רווחים במקפים, מסיר סימני פיסוק ותווי עיצוב (כגון נטוי), גוזם רווחים עודפים, ואם התוצאה תואמת כותרת קודמת אחרת, הוסף סיומת מספרית (-1, -2 וכו') כדי להפוך אותו לייחודי.

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

הדגשות, טקסט מודגש וציטוטים

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

כדי להכניס טקסט נועזטקסט מודגש מוקף בכוכביות כפולות או בקו תחתון כפול; עבור כתב נטוי, משתמשים בכוכביות בודדות או בקו תחתון; כדי למתוח קו חוצה, ממוקמת טילדה כפולה (שתי טילדות) משני צידי הטקסט. ניתן גם לשלב אותיות מודגשות וכתב נטוי מקוננות, ניתן להשתמש בשלוש כוכביות כדי להחיל את שתיהן על קטע טקסט שלם, או להשתמש בתגיות HTML כגון <br>. _{y ^{עבור כתבי תחתון וכתבי עיליים, ו לצורך קו תחתון.}}

GitHub מאפשר לך גם ליצור ציטוטים בסגנון blockquote על ידי הצבת סמל הגדול מ-(>) בתחילת השורה, הטקסט המצוטט מוצג עם פס אנכי משמאל ובאפור, מה שמבליט אותו בבירור. ניתן לכלול מספר שורות באותו בלוק ציטוט, וניתן אף לקנן ציטוטים על ידי הוספת סמלים > נוספים בתחילת השורה.

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

Reddit תומך גם במירכאות פשוטות עם אותו סמל >, למרות שחסרה לה מערכת ההתראות העשירה של GitHub. למרות זאת, היא נותרה דרך שימושית מאוד ל... תשובה למישהו על ידי ציטוט חלק מההודעה שלו בלי לחזור על זה לגמרי.

הדגשת קוד, בלוקים וצבעים

גם GitHub וגם Reddit מאפשרים לך לסמן קטעי קוד בתוך הטקסט באמצעות backticks. עבור קוד מוטבע, אתה סוגר את המילה או הפקודה עם backtick יחיד מכל צד. זה אידיאלי להדגשת, למשל, מצב git בתוך משפט, תוך הבהירות שמדובר בפקודה.

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

GitHub מציע גם תכונה ספציפית להדגשה ערכי צבע בתוך קודים אחוריים. אם תכתבו צבע בפורמט הקסדצימלי, RGB או HSL בין קודים אחוריים, הפלטפורמה כוללת מחוון צבע קטן ליד הטקסט. לדוגמה, אם הרקע במצב בהיר הוא #ffffff ובמצב כהה #000000, סימון קודים אלה מאפשר לכם לראות במהירות איזה הוא איזה.

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

Reddit תומך גם בבלוקים של קוד עם backticks, הן inline והן block, אם כי השימוש בהם שם מתמקד יותר בקטעי קוד קטנים או פסאודו-קוד מאשר בתיעוד ארוך כמו זה של מאגר.

קישורים, עוגנים וניווט פנימי

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

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

קישור יחסי הוא קישור המחושב באמצעות הקובץ הנוכחי כמקור. לדוגמה, אם קובץ ה-README שלך נמצא בשורש הפרויקט ואתה רוצה לקשר לקובץ docs/CONTRIBUTING.md, אתה פשוט כותב קישור עם הנתיב docs/CONTRIBUTING.md. GitHub מטפל בתרגום נכון של קישור יחסי זה בכל ענף שאתה נמצא בו, ומונע ממנו להישבר בעת מעבר בין ענפים או שכפול המאגר.

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

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

תמונות ב-GitHub: Markdown, HTML ונתיבים יחסיים

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

תמונות יכולות להגיע מקבצים בתוך המאגר עצמו או מכתובות URL חיצוניות. GitHub מאפשר מספר דפוסי נתיב יחסיים להעלאת תמונות מענפים שונים, מאגרים אחרים, או אפילו בעיות והערות, באמצעות סיומות כגון ?raw=אמת כדי לאלץ הורדה ישירה של הקובץ בעת הצורך.

בנוסף לתחביר הסטנדרטי של Markdown, GitHub תומך בשימוש באלמנט HTML פריט זה שימושי במיוחד לטעינה תמונות רספונסיביות אלה משתנים בהתאם להעדפות התבנית של המשתמש (בהיר או כהה). באמצעות שאילתת המדיה `prefers-color-scheme`, ניתן להגדיר מקורות תמונה שונים עבור כל מצב, ותמונת ברירת מחדל עבור דפדפנים שאינם תומכים בתכונה זו.

הדפוס הטיפוסי כרוך בהכללה בתוך מספר אלמנטים עם תכונות המדיה וה-srcset שלה, ולבסוף א באמצעות המאפיין alt וכתובת URL כללית, משתמשים במצב כהה רואים תמונה מותאמת, בעוד שאלו במצב בהיר מקבלים תמונה שונה, מבלי שיהיה צורך לשכפל תוכן בקובץ README.

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

טבלאות, חלקים מתקפלים והפרדת תוכן

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

טבלאות שימושיות מאוד להצגת רשימות של שפות תכנות, מסגרות (frameworks) שבהן נעשה שימוש, משימות מתוכננות, השוואות תכונות או כל מידע אחר שנהנה ממבנה מטריצה. GitHub מעבד טבלאות אלו בסגנון נקי וקריא.

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

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

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

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

הערות נסתרות ובקרת עיצוב

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

לדוגמה, בקובץ README של הפרופיל ניתן להוסיף הערה שאומרת משהו כמו שצריך להרחיב את הקטע "אודותיי" מאוחר יותר או שצריך לעיין בטבלה של טכנולוגיות מיושנות, מבלי שאף אחד שמבקר בפרופיל יראה זאת ישירות.

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

כשאתה צופה בקובץ סימון ב-GitHub, יש לך אפשרות לעבור בין התצוגה המעובדת לקוד המקור באמצעות כפתור בחלק העליון (או לפתוח אותו בעורכים כמו...) בסוגרייםהשבתת פירוש Markdown מאפשרת לך גישה לתכונות תצוגת קוד אופייניות כגון קישור שורות ספציפיותזה מאוד שימושי כשרוצים להצביע על חלק מדויק של קובץ README או כל קובץ .md אחר.

לבסוף, זכרו ש-GitHub מטפל במעברי שורה בצורה שונה בתגובות (בעיות, הודעות פרטיות וכו') ובקבצי .md. בתגובות, מעברי שורה מטופלים ישירות, בעוד שבקבצי Markdown יש להוסיף שני רווחים בסוף השורה, קו נטוי הפוך או נקודה. כדי לאלץ את הקפיצה בתוך אותה פסקה.

רשימות, רשימות מקוננות ורשימות מטלות

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

כדי ליצור רשימות הורהכל שורה ממוספרת במספר ואחריו נקודה ורווח. אמנם סדר המספרים אינו חייב להיות מושלם (GitHub בדרך כלל מחשב אותו מחדש), אך מומלץ לשמור על מספור עקבי כדי להפוך את קוד המקור לקריא.

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

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

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

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

אזכורים, הפניות ואמוג'ים ב-GitHub

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

כשמקישים את הסימן @, GitHub מציג רשימה של משתמשים וצוותים המשויכים למאגר או לשרשור, וניתן לסנן רשימה זו תוך כדי הקלדה. השתמשו במקשי החצים והקישו Enter או Tab כדי לקבל את ההצעות. עבור צוותים, השתמשו בפורמט @organization/team-name, וכל חברי הצוות יהיו רשומים לשרשור.

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

אם במאגר שלך מוגדרות הפניות מקושרות אוטומטית מותאמות אישית, ייתכן שגם סימונים חיצוניים מסוימים (כגון מזהי כרטיסי JIRA או Zendesk) יומרו אוטומטית לקישורים קצרים. הגדרה זו דורשת הרשאות ניהול, אך לאחר הפעלתה, היא מאפשרת שיתוף נתונים בין-מערכות במאמץ מינימלי.

לבסוף, GitHub תומך באימוג'ים באמצעות קוד: הקלד נקודתיים, ואחריהם שם האימוג'י, וסיימו בנקודתיים נוספים. כשמתחילים להקליד, מופיעה רשימה של הצעות, אותן ניתן לאשר באמצעות Tab או Enter. שילוב אימוג'ים בתגובות שלך עוזר להן להעניק מגע אנושי יותר, כל עוד לא משתמשים בהם יתר על המידה בתיעוד רשמי.

הערות שוליים ותוכן מתקדם

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

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

תכונה מתקדמת נוספת שמציעה GitHub היא... התראות אלה כבר נדונו (הערה, טיפ, חשוב, אזהרה וזהירות). מומלץ להשתמש בהם רק כאשר באמת נחוץ ולהימנע מחיבור של יותר מדי יחד כדי למנוע עומס על הקורא. לא ניתן לקנן אותם בתוך אלמנטים מורכבים אחרים, לכן חיוני לתכנן בקפידה את מיקומם.

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

Markdown ברדיט: Snoomark ומצב עריכה

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

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

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

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

תחביר נתמך על ידי Reddit וספוילרים

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

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

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

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

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

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