מרקדאון, בייבי

19/11/2023 כללי · כתיבה בלוג טכנולוגיה גיקיות הסחת-דעת תכנות הוגו

תוכן

הקדמה

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

מרק... מה?

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

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

אבל למה זה צריך לעניין אותנו בכלל?

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

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

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

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

למה זה כל כך פשוט?

בואו נחזור שנייה ל-HTML.

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

אפשר דוגמא?

בוודאי! בואו ניקח לרגע את הטקסט המעוצב הבא:

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

כך הטקסט הזה כתוב ב-HTML:

<h1>כותרת המסמך</h1>
<p>כאן יש לנו דוגמא למסמך מרקדאון פשוט עם כמה דוגמאות בסיסיות.</p>
<p>כאן יהיה <strong>טקסט מודגש</strong>, <em>טקסט נטוי</em>, וגם <em>טקסט נטוי שחלקו <strong>מודגש</strong></em>.</p>
<p>אפשר גם לשים טקסט עם <del>קו חוצה</del>, ואחריו <a href="https://aizenimr.com">קישור לאתר ממש מגניב</a>.</p>
<p>או אפילו תמונה!</p>
<p><img src="http://placebear.com/200/200" alt="דוב"></p>

וכך אותו הטקסט כתוב במרקדאון (תוכלו ללחוץ על 3 הנקודות המופיעות בסוף הבלוק כדי לפתוח במלואו):

 1# כותרת המסמך
 2כאן יש לנו דוגמא למסמך מרקדאון פשוט עם כמה דוגמאות בסיסיות.
 3
 4כאן יהיה **טקסט מודגש**, *טקסט נטוי*, וגם *טקסט נטוי שחלקו **מודגש***.
 5
 6אפשר גם לשים טקסט עם ~~קו חוצה~~, ואחריו [קישור לאתר ממש מגניב](https://aizenimr.com).
 7
 8או אפילו תמונה!
 9
10![דוב](http://placebear.com/200/200)

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

יש למרקדאון חוקים ודיקדוק?

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

סוג טקסט	כתיבה במרקדאון
כותרת ראשית	# טקסט
כותרת משנית	## טקסט (בכל סולמית שמוסיפים הכותרת קטנה יותר)
מודגש	טקסט מודגש
נטוי	טקסט נטוי
ציטוט	> טקסט מצוטט
רשימה ממוספרת	1. פריט 2. פריט 3. פריט
רשימה לא ממסופרת	- פריט - פריט - פריט
`קוד של שפת תכנות`	``` בלוק קוד שלם ``` ואפשר גם `לסמן חלק משורה באופן הזה`
קישור	[טקסט](כתובת הקישור)
תמונה	![טקסט לתיאור התמונה](image.jpg)

מניסיון - 4 הפריטים הראשונים נמצאים בשימוש תדיר.

יש משהו מעצבן במרקדאון?

כן!

מה שהכי מעצבן משתמשים חדשים הוא הטיפול בשורה חדשה. למה הכוונה?

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

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

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

איזה עורך מומלץ?

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

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

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