כיצד להשתמש ב-pandoc כדי להמיר קבצים בשורת הפקודה של לינוקס

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

Fatmawati Achmad Zaenuri/Shutterstock



אתה יכול להשתמש ב-|_+_| ב-Linux כדי להמיר בין יותר מ-40 פורמטים של קבצים. אתה יכול גם להשתמש בו כדי ליצור מערכת מסמכים כקוד פשוטה על ידי כתיבה ב-Markdown, אחסון ב-|_+_| ופרסום בכל אחד מהפורמטים הנתמכים שלו.

המרת מסמכים ומסמכים כקוד

אם יש לך מסמך באחד מ-|_+_| פורמטי קבצים נתמכים רבים , להמיר אותו לכל אחד מהאחרים זה פשוט קל. זה כלי שימושי שיש!





אבל הכוח האמיתי של |_+_| מתברר כאשר אתה משתמש בו כבסיס למערכת מסמכים כקוד פשוטה. הנחת היסוד של docs-as-code היא לאמץ חלק מהטכניקות והעקרונות של פיתוח תוכנה וליישם אותם בכתיבת תיעוד, במיוחד עבור פרויקטי פיתוח תוכנה. עם זאת, אתה יכול ליישם אותו לפיתוח של כל סוג של תיעוד.

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



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

פרסומת

כשהם מוכנים לייצר גרסה עובדת של התוכנית, הם משתמשים ב-a מַהְדֵר כדי לקרוא את קוד המקור וליצור קובץ הפעלה בינארי.

על ידי כתיבת המסמכים שלך בשפת סימון קלת משקל, מבוססת טקסט, תוכל להשתמש ב-VCS כדי לשלוט בגרסה בכתיבה שלך. כאשר אתה מוכן להפיץ או לפרסם מסמך, אתה יכול להשתמש ב-|_+_| ליצור כמה גרסאות שונות של התיעוד שלך שאתה צריך, כולל מבוססי אינטרנט ( HTML ), עיבוד תמלילים או מודפס ( LibreOffice , מייקרוסופט וורד , TeX ), פורמט מסמך נייד ( PDF ), ספר אלקטרוני ( ePub ), וכולי.



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

מתקין Pandoc

כדי להתקין |_+_| באובונטו, השתמש בפקודה הזו:

pandoc

בפדורה, הפקודה שאתה צריך היא הבאה:

git

במנג'רו, עליך להקליד:

pandoc's

אתה יכול לבדוק איזו גרסה התקנת על ידי שימוש ב- |_+_| אוֹפְּצִיָה:

pandoc

שימוש ב-pandoc ללא קבצים

אם אתה משתמש ב-|_+_| ללא כל אפשרויות שורת פקודה, הוא מקבל גם קלט מודפס. אתה פשוט הקש Ctrl+D כדי לציין שסיימת להקליד. |_+_| מצפה ממך להקליד בפורמט Markdown, והוא מייצר פלט HTML.

בואו נסתכל על דוגמה:

pandoc

הקלדנו כמה שורות של Markdown ועומדים ללחוץ על Ctrl+D.

פרסומת

ברגע שנעשה זאת, |_+_| מייצר את פלט ה-HTML המקביל.

אבל כדי לעשות משהו שימושי עם |_+_|, אנחנו באמת צריכים להשתמש בקבצים.

יסודות ה-Markdown

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

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

  • להדגשת טקסט עם אוֹתִיוֹת מוּטוֹת , עטפו אותו בכוכביות. |_+_|
  • ל נוֹעָז טקסט, השתמש בשתי כוכביות. |_+_|
  • כותרות מיוצגות על ידי סימן מספר/סימן גיבוב (|_+_|). טקסט מופרד מה-hash ברווח. השתמש ב-hash אחד עבור כותרת ברמה העליונה, שניים עבור רמה שנייה וכן הלאה.
  • כדי ליצור רשימה עם תבליטים, התחל כל שורה ברשימה בכוכבית והכנס רווח לפני הטקסט.
  • כדי ליצור רשימה ממוספרת, התחל כל שורה בספרה ואחריה נקודה, ולאחר מכן הוסף רווח לפני הטקסט.
  • כדי ליצור היפר-קישור, הקף את שם האתר בסוגריים מרובעים (|_+_|), ואת כתובת האתר בסוגריים [|_+_|] כך: |_+_|.
  • כדי להוסיף תמונה, הקלד סימן קריאה מיד לפני סוגריים (|_+_|). הקלד כל טקסט חלופי עבור התמונה בסוגריים. לאחר מכן, הקף את הנתיב לתמונה בסוגריים [|_+_|]. הנה דוגמה: |_+_|.

נסקור דוגמאות נוספות לכל אלה בסעיף הבא.

קָשׁוּר: מהו Markdown וכיצד משתמשים בו?

המרת קבצים

המרות קבצים הן פשוטות. |_+_| בדרך כלל יכולים להבין עם אילו פורמטי קבצים אתה עובד מתוך שמות הקבצים שלהם. כאן, אנחנו הולכים ליצור קובץ HTML מקובץ Markdown. ה- |_+_| אפשרות (פלט) אומרת |_+_| שם הקובץ שאנו רוצים ליצור:

pandoc

פרסומת

קובץ Markdown לדוגמה שלנו, sample.md, מכיל את הקטע הקצר של Markdown המוצג בתמונה למטה.

טקסט סימון בקובץ sample.md בחלון עורך gedit.

נוצר קובץ בשם sample.html. כאשר אנו לוחצים פעמיים על הקובץ, דפדפן ברירת המחדל שלנו יפתח אותו.

עיבוד HTML של קובץ ה-markdown sample.md, בחלון דפדפן.

עכשיו, בואו ניצור פתח את פורמט המסמך מסמך טקסט שנוכל לפתוח בו LibreOffice Writer :

--version

לקובץ ODT יש תוכן זהה לקובץ HTML.

מסמך ODT שעובד מ-markdown ונפתח ב-LibreOffice Writer.

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

כיתוב תמונה שנוצר אוטומטית ב-LibreOffice Writer.

ציון תבניות קבצים

ה- |_+_| (מ) ו-|_+_| (to) אפשרויות משמשות כדי לדעת |_+_| לאילו פורמטים של קבצים ברצונך להמיר ואליהם. זה יכול להיות שימושי אם אתה עובד עם פורמט קובץ שחולק סיומת קובץ עם פורמטים קשורים אחרים. לדוגמה, TeX , ו שרף גומי שניהם משתמשים בסיומת .tex.

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

אנו מקלידים את הדברים הבאים:

pandoc

פרסומת

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

קובץ LaTeX פתוח ב-Texmaker, המציג תצוגה מקדימה של דף ערכת הטיפוס.

השתמשנו בעורך LaTeX שנקרא טקסמייקר . אם אתה רוצה להתקין אותו באובונטו, הקלד את הדברים הבאים:

pandoc

בפדורה, הפקודה היא:

pandoc

במנג'רו, השתמש ב:

pandoc

המרת קבצים עם תבניות

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

עם תבניות, אתה יכול להכתיב אילו סגנונות |_+_| משתמש כאשר הוא יוצר מסמכים. לדוגמה, אתה יכול לדעת |_+_| להשתמש בסגנונות המוגדרים ב-a גיליונות סגנון מדורגים קובץ (CSS) עם הקובץ |_+_| אוֹפְּצִיָה.

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

*This will be emphasized*

הפקודה המלאה נמצאת למטה - שימו לב שהשתמשנו גם באפשרות העצמאית (|_+_|):

**This will be in bold**פרסומת

|_+_| משתמש בסגנון היחיד מקובץ ה-CSS המינימליסטי שלנו ומחיל אותו על הכותרת ברמה אחת.

HTML מעובד מ-markdown עם סגנון CSS שהוחל על הכותרת ברמה אחת, בחלון דפדפן

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

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

אנו יכולים לציין באילו סגנונות נעשה שימוש גם כאשר נוצרים קבצי ODT. פתח מסמך LibreOffice Writer ריק והתאם את סגנונות הכותרת והגופן כך שיתאימו לצרכים שלך. בדוגמה שלנו, הוספנו גם כותרת עליונה ותחתונה. שמור את המסמך שלך בתור odt-template.odt.

כעת נוכל להשתמש בזה כתבנית עם |_+_| אוֹפְּצִיָה:

#

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

קובץ ODT שעובד מ-markdown עם מסמך LibreOffice הפועל כגיליון סגנונות, בחלון LibreOffice Writer.

פרסומת

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

הפקת קובצי PDF

כברירת מחדל, |_+_| משתמש במנוע ה-PDF של LaTeX כדי ליצור קבצי PDF. הדרך הקלה ביותר לוודא שיש לך את התלות המתאימה של LaTeX היא להתקין עורך LaTeX, כגון Texmaker.

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

Docs-as-Code

ישנם מספר יתרונות לשימוש ב-Markdown כשפת הכתיבה שלך, כולל היתרונות הבאים:

    העבודה בקבצי טקסט רגיל מהירה:הם נטענים מהר יותר מקבצי מעבד תמלילים בגודל דומה, ונוטים לעבור במסמך מהר יותר גם כן. עורכים רבים, כולל |_+_| , |_+_| , ו-|_+_|, השתמשו בהדגשת תחביר עם טקסט Markdown. יהיה לך ציר זמן של כל הגרסאות של המסמכים שלך:אם אתה מאחסן את התיעוד שלך ב-VCS, כגון Git, אתה יכול לראות בקלות את ההבדלים בין כל שתי גרסאות של אותו קובץ. עם זאת, זה באמת עובד רק כאשר הקבצים הם טקסט רגיל, שכן זה מה ש-VCS מצפה לעבוד איתו. VCS יכול לתעד מי ביצע שינויים, ומתי:זה מועיל במיוחד אם אתה לעתים קרובות משתף פעולה עם אחרים בפרויקטים גדולים. הוא גם מספק מאגר מרכזי עבור המסמכים עצמם. רב שירותי Git המתארחים בענן, כגון GitHub , GitLab , ו BitBucket , יש רמות חינמיות בדגמי התמחור שלהם. אתה יכול ליצור את המסמכים שלך במספר פורמטים:רק עם כמה סקריפטים של מעטפת פשוטים, אתה יכול למשוך את הסגנונות מ-CSS ומסמכי עזר. אם אתה מאחסן את המסמכים שלך במאגר VCS שמשתלב עם אינטגרציה רציפה ופריסה רציפה פלטפורמות (CI/CD), ניתן להפיק אותן באופן אוטומטי בכל פעם שהתוכנה נבנית.

קָשׁוּר: מה זה GitHub ולמה הוא משמש?

מחשבות אחרונות

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

פקודות לינוקס
קבצים זֶפֶת · pv · חתול · טק · chmod · אחיזה · הבדל · sed · עם · איש · דחף · popd · fsck · testdisk · seq · fd · פנדוק · CD · $PATH · מביך · לְהִצְטַרֵף · jq · לְקַפֵּל · ייחודי · journalctl · זָנָב · מדינה · ls · fstab · זרק · פָּחוּת · chgrp · chown · לְהַאִיץ · תראה · מחרוזות · סוּג · לשנות שם · רוכסן · לִפְתוֹחַ · הר · umount · להתקין · fdisk · mkfs · rm · rmdir · rsync · df · gpg · אָנוּ · ננו · mkdir · מ · ב · תיקון · להמיר · rclone · שמץ · SRM
תהליכים כינוי · מָסָך · חלק עליון · נֶחְמָד · נחמדים · התקדמות · רצועה · מערכת · tmux · chsh · הִיסטוֹרִיָה · בְּ- · קבוצה · חינם · איזה · dmesg · usermod · נ.ב · chroot · xargs · tty · זרת · lsof · vmstat · פסק זמן · קִיר · כן · לַהֲרוֹג · לִישׁוֹן · סודו · שֶׁלוֹ · זְמַן · הוספה קבוצתית · usermod · קבוצות · לשוו · לכבות · לְאַתחֵל · תפסיק · כיבוי · passwd · lscpu · crontab · תַאֲרִיך · bg · fg
רשת netstat · פינג · traceroute · ip · ss · מי זה · fail2ban · bmon · אתה · אֶצבַּע · nmap · ftp · סִלְסוּל · wget · מי · מי אני · ב · iptables · ssh-keygen · ufw

קָשׁוּר: מחשבי Linux הטובים ביותר למפתחים וחובבי

קרא את הבא תמונת פרופיל עבור דייב מקיי דייב מקיי
דייב מקיי השתמש לראשונה במחשבים כשסרט נייר מחורר היה באופנה, ומאז הוא מתכנת. לאחר למעלה מ-30 שנה בתעשיית ה-IT, הוא כעת עיתונאי טכנולוגיה במשרה מלאה. במהלך הקריירה שלו, הוא עבד כמתכנת עצמאי, מנהל צוות פיתוח תוכנה בינלאומי, מנהל פרויקטים של שירותי IT, ולאחרונה כמנהל הגנת מידע. הכתיבה שלו פורסמה על ידי howtogeek.com, cloudsavvyit.com, itenterpriser.com ו-opensource.com. דייב הוא אוונגליסט של לינוקס ותומך בקוד פתוח.
קרא את הביוגרפיה המלאה

מאמרים מעניינים