kramdown - מקוון בענן

תָכְנִית:

שֵׁם

kramdown - ממיר מהיר וטהור Ruby Markdown-Superset

תַקצִיר

קראמדאון [אפשרויות] [קובץ ...]

תיאור

kramdown משמש בעיקר לניתוח קבוצת-על של Markdown והמרתו
פורמטים שונים של פלט. זה תומך ב-Markdown רגיל (עם כמה שינויים קלים)
והרחבות שונות כמו טבלאות ורשימות הגדרות. בשל הארכיטקטורה המודולרית שלו
זה גם מאפשר פורמטי קלט אחרים מאשר Markdown, למשל HTML או Github Flavored
Markdown.

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

ישנן שתי קבוצות של אפשרויות ש-kramdown מקבל: הראשונה כוללת את האפשרויות
המשמשים ישירות את הבינארי kramdown. קבוצת האפשרויות השנייה שולטת כיצד
kramdown מנתח וממיר את הקלט שלו.

אפשרויות

-אני, --קֶלֶט ARG
ציין את פורמט הקלט. פורמטי קלט זמינים: kramdown (זו ברירת המחדל),
markdown, GFM או html.

-או, --תְפוּקָה ARG
ציין פורמט פלט אחד או יותר מופרדים בפסיקים: html (ברירת מחדל), kramdown,
לטקס, pdf או remove_html_tags.

-ב, --גִרְסָה
הצג את הגרסה של kramdown.

-ח, - עזרה
הראה את העזרה.

קרמדאון אפשרויות

--auto-id-prefix ARG

קידומת המשמשת למזהי כותרות שנוצרו אוטומטית

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

ברירת מחדל: '' בשימוש על ידי: ממיר HTML/Latex

--[no-]הסרת מזהה אוטומטית

הסר את כל העיצוב מטקסט הכותרת ליצירת מזהה אוטומטית

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

אפשרות זו תוסר בגרסה 2.0 מכיוון שזו תהיה ברירת המחדל אז.

ברירת מחדל: false בשימוש על ידי: kramdown parser

--[no-]מזהים אוטומטיים

השתמש ביצירת מזהה כותרת אוטומטית

אם אפשרות זו היא 'אמת', ערכי מזהה עבור כל הכותרות נוצרים אוטומטית אם
שום מזהה לא צוין במפורש.

ברירת מחדל: true בשימוש: ממיר HTML/Latex

--coderay-bold-every ARG

מגדיר באיזו תדירות יש להפוך מספר קו מודגש

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

ברירת מחדל: 10 בשימוש על ידי: ממיר HTML

--coderay-css ARG

מגדיר כיצד הקוד המודגש מקבל סגנון

ערכים אפשריים הם :class (מחלקות CSS מוחלות על רכיבי הקוד, חייבים
ספק את קובץ ה-CSS הדרוש) או :style (סגנונות ברירת המחדל של CSS מוחלים ישירות עליהם
רכיבי הקוד).

ברירת מחדל: סגנון בשימוש: ממיר HTML

--coderay-default-lang ARG

מגדיר את שפת ברירת המחדל להדגשת בלוקי קוד

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

ברירת מחדל: אפס בשימוש: ממיר HTML

--coderay-line-number-start ARG

ערך ההתחלה עבור מספרי השורות

ברירת מחדל: 1 בשימוש על ידי: ממיר HTML

--מספרי-קו-קוד ARG

מגדיר כיצד ואם יש להציג מספרי שורות

הערכים האפשריים הם :table, :inline או nil. אם אפשרות זו היא אפסית, אין קו
המספרים מוצגים.

ברירת מחדל: :inline בשימוש על ידי: ממיר HTML

--coderay-tab-width ARG

רוחב הכרטיסייה בקוד המודגש

בשימוש על ידי: ממיר HTML

--coderay-wrap ARG

מגדיר כיצד יש לעטוף את הקוד המודגש

הערכים האפשריים הם :span, :div או nil.

ברירת מחדל: :div בשימוש על ידי: ממיר HTML

--[no-]enable-coderay

השתמש ב-coderay להדגשת תחביר

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

ברירת מחדל: true בשימוש: ממיר HTML

--יישות-פלט ARG

מגדיר את אופן הפלט של ישויות

הערכים האפשריים הם :as_input (ישויות מופקות באותה צורה כמו שנמצאת ב
הקלט), :נומרי (ישויות מופקות בצורה מספרית), :סימבולי (ישויות הן
פלט בצורה סמלית אם אפשר) או :as_char (ישויות מופלטות כתווים
אם אפשר, זמין רק ב-Ruby 1.9).

ברירת מחדל: :as_char בשימוש: ממיר HTML, ממיר kramdown

--הערת שוליים-קישור חוזר ARG

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

הקישור האחורי של הערת השוליים הוא רק טקסט, כך שכל תווי HTML מיוחדים יקוצצו.

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

ברירת מחדל: '&8617;' בשימוש על ידי: ממיר HTML

--הערת שוליים-nr ARG

המספר של הערת השוליים הראשונה

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

ברירת מחדל: 1 בשימוש על ידי: ממיר HTML

--[לא-]עטיפה קשה

מפרש מעברי שורות פשוטו כמשמעו

הכנס HTML ` ` תגים בתוך פסקאות שבהן מסמך Markdown המקורי
היו שורות חדשות (כברירת מחדל, Markdown מתעלם מהשורות החדשות הללו).

ברירת מחדל: true בשימוש: מנתח GFM

--הסטת כותרת ARG

מגדיר את היסט הפלט עבור כותרות

אם אפשרות זו היא c (יכולה להיות גם שלילית) אז כותרת עם רמה n תהיה
פלט ככותרת עם רמה c+n. אם c+n נמוך מ-1, רמה 1 תשמש. אם
c+n גדול מ-6, ייעשה שימוש ברמה 6.

ברירת מחדל: 0 בשימוש על ידי: ממיר HTML, ממיר Kramdown, ממיר לטקס

--[no-]html-to-native

המרת רכיבי HTML לאלמנטים מקוריים

אם אפשרות זו היא 'נכונה', המנתח ממיר רכיבי HTML לאלמנטים מקוריים. ל
לדוגמה, בעת ניתוח של ` hallo `, תג ההדגשה יומר בדרך כלל
לרכיב `:html` עם סוג התג `:em`. אם `html_to_native` הוא `true`, אז ה-
הדגש יומר לאלמנט `:em` מקורי.

זה שימושי לממירים שאינם יכולים להתמודד עם רכיבי HTML.

ברירת מחדל: false בשימוש על ידי: kramdown parser

--כותרות לטקס ARG

מגדיר את פקודות ה-LaTeX עבור רמות כותרת שונות

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

ברירת מחדל: סעיף, סעיף משנה, תת-סעיף, פסקה, תת-פסקה, תת-פסקה בשימוש
מאת: ממיר לטקס

--רוחב קו ARG

מגדיר את רוחב הקו שישמש בעת הוצאת מסמך

ברירת מחדל: 72 בשימוש: ממיר kramdown

--link-defs ARG

מגדיר מראש הגדרות קישור

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

אם הערך הוא String, הוא חייב להכיל גיבוב YAML חוקי וה-hash חייב
פעל לפי ההנחיות לעיל.

ברירת מחדל: {} בשימוש על ידי: מנתח kramdown

--מתמטיקה-מנוע ARG

הגדר את מנוע המתמטיקה

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

ניתן להגדיר אפשרויות עבור מנוע המתמטיקה הנבחר באמצעות ה-math_engine_opts
אפשרות תצורה.

ברירת מחדל: mathjax בשימוש על ידי: ממיר HTML

--מתמטיקה-מנוע-אופטס ARG

הגדר את אפשרויות המנוע המתמטי

מציין אפשרויות עבור מנוע המתמטיקה שהוגדר באמצעות אפשרות התצורה math_engine.

הערך צריך להיות hash עם צמדי מפתח-ערך המובנים למשתמשים
מנוע מתמטי.

ברירת מחדל: {} בשימוש על ידי: ממיר HTML

--[no-]parse-block-html

עבד תחביר kramdown בתגי HTML בלוק

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

ברירת מחדל: false בשימוש על ידי: kramdown parser

--[no-]נתח-span-html

עבד תחביר kramdown בתגי HTML span

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

ברירת מחדל: true בשימוש: kramdown parser

--[no-]remove-block-html-tags

הסר תגי HTML בלוק

אם אפשרות זו היא 'נכונה', ממיר RemoveHtmlTags מסיר תגי HTML בלוקים.

ברירת מחדל: true בשימוש: RemoveHtmlTags ממיר

--[no-]remove-span-html-tags

הסר תגיות HTML של span

אם אפשרות זו היא 'נכונה', ממיר RemoveHtmlTags מסיר תגי HTML span.

ברירת מחדל: false בשימוש על ידי: RemoveHtmlTags ממיר

--ציטוטים חכמים ARG

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

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

ברירת מחדל: lsquo,rsquo,ldquo,rdquo בשימוש על ידי: HTML/Latex converter

--מדגיש תחביר ARG

הגדר את סימון התחביר

מציין את מדגיש התחביר שיש להשתמש בו להדגשת בלוקי קוד
ומתפרשים. אם אפשרות זו מוגדרת ל-+nil+, לא מתבצעת הדגשת תחביר.

ניתן להגדיר אפשרויות עבור מדגיש התחביר באמצעות ה-syntax_highlighter_opts
אפשרות תצורה.

ברירת מחדל: coderay בשימוש: HTML/Latex converter

-- תחביר-מדגיש-אופטס ARG

הגדר את אפשרויות סימון התחביר

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

הערך צריך להיות hash עם צמדי מפתח-ערך המובנים למשתמשים
מדגיש תחביר.

ברירת מחדל: {} בשימוש: ממיר HTML/Latex

--תבנית ARG

שם קובץ תבנית ERB שבו יש להשתמש כדי לעטוף את הפלט או ה-ERB
התבנית עצמה.

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

בעת פתרון קובץ התבנית, תחילה נעשה שימוש בשם התבנית הנתון. אם כזה
הקובץ לא נמצא, סיומת הממיר (זהה לשם הממיר).
מצורף. אם עדיין לא ניתן למצוא את הקובץ, שם התבניות מתפרש כ-a
שם תבנית שמסופק על ידי kramdown (ללא סיומת הממיר). אם
הקובץ עדיין לא נמצא, שם התבנית נבדק אם הוא מתחיל עם
'string://' ואם כן, הקידומת הזו מוסרת והשאר משמש כתבנית
תוכן.

kramdown מספק תבנית ברירת מחדל בשם 'מסמך' עבור כל ממיר.

ברירת מחדל: '' בשימוש על ידי: כל הממירים

--to-רמות ARG

מגדיר את הרמות המשמשות לתוכן העניינים

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

ברירת מחדל: 1..6 בשימוש: ממיר HTML/Latex

--[no-]transliterated-header-IDs

תעתיק את טקסט הכותרת לפני יצירת המזהה

רק תווי ASCII משמשים במזהי כותרות. זה לא טוב לשפות עם
תווים רבים שאינם ASCII. על ידי הפעלת אפשרות זו טקסט הכותרת הוא
תעתיק ל-ASCII טוב ככל האפשר כך שמזהה הכותרת המתקבל יהיה גדול יותר
מוֹעִיל.

יש להתקין את ספריית stringex כדי שתכונה זו תעבוד!

ברירת מחדל: false בשימוש: ממיר HTML/Latex

יְצִיאָה סטָטוּס

מצב היציאה הוא 0 אם לא קרתה שגיאה. אחרת זה 1.

השתמש ב-kramdown באינטרנט באמצעות שירותי onworks.net