Markowik הוא יישום פייתון שממיר טקסט מעוצב Markdown לWiki קוד Google.
Markowik הוא מסוגל להמיר את רוב מבני Markdown להשווים Wiki קוד Google (GCW). במקום רשימה של כל ההמרות הנתמכות, אנא יש להסתכל על חבילת הבדיקות של Markowik ומקרה תכניתה.
התקנה
הפעל:
PIP להתקין markowik
או:
easy_install markowik
ניתן גם להשתמש בMarkowik ללא התקנה, כפי שתואר תחת לתרום.
שימוש שורת הפקודה
מתפוקת העזרה:
שימוש: markowik [-h] [--mx [MX [MX ...]]] [URL --image-baseurl]
& Nbsp; [- html-תמונות] [קידוד --encoding] [--quiet]
& Nbsp; INFILE [outfile]
המרת Markdown לWiki קוד Google.
טיעוני positional:
& Nbsp; קובץ markdown INFILE
& Nbsp; קובץ wiki outfile (ברירת מחדל: stdout)
טיעונים אופציונליים:
& Nbsp; -h, --help יציג הודעת עזרה זה וצא
& Nbsp; - mx [[MX ...] MX] הרחבות markdown כדי להפעיל
& Nbsp; - URL בסיס כתובת אתר של התמונה-baseurl לצרף בתחילת שורה למקומות תמונה יחסי
& Nbsp; - html-תמונות תמיד להשתמש ב- HTML לתמונות
& Nbsp; - קידוד קידוד הקידוד של קלט ופלט (ברירת מחדל: UTF8)
& Nbsp; - הודעות מידע להשבית שקטה
הרחבות Markdown יכולות להינתן באופן דומה באשר לשורת פקודת כלי Python Markdown (PyMD), למעט שסיומות אדם חייבים להיות מופרדות על ידי חלל:
markowik שולחנות --mx INPUT def_list
סיומות נתמכות כרגע (נבדקו כלומר) הן abbr, שולחנות, וdef_list. סיומות אחרות בדרך כלל צריכה לעבוד יותר מדי, אבל עשוי להניב תוצאות לא צפויות בטקסט wiki המומר.
בנוגע ל--html-תמונות האופציה, ראה הסברים בהמשך במגבלות.
שימוש פרוגרמטי
Markowik מיושם בפייתון. מודול markowik מספק להמיר פונקציה בשם. סמנטי זה דומה לממשק שורת הפקודה (טיעונים של מילות מפתח מתאימות לפקד אפשרויות שורה). הנה דוגמא לשימוש קצרה:
>>> Markowik יבוא
>>> Markowik.convert ("... הטקסט * * markdown חלק", = ['שולחנות'] mx)
על מודעה _markdown_ u'Some ... "
דף Pragmas
ניתן להגדיר pragmas דף GCW בקבצי מקור Markdown כmeta נתונים בפורמט שהוגדר על ידי הארכת meta PyMD:
>>> Src = "" סיכום ": סיכום דף
... תוויות: כמה, תוויות
...
... הנה מתחיל הדף * * ..
... "" "
>>> Markowik.convert הדפסה (src, mx = ['meta'])
סיכום דף #summary
#labels כמה, תוויות
כאן מתחיל _page_ ..
שים לב שסיומת meta צריך להיות מופעלת באופן מפורש, כלומר כברירת מחדל Markowik אינו מכירה pragmas דף
מה חדש במהדורה זו:.
< >
מה חדש בגרסת 0.1.1:.
- תיעוד משופר
- תיקונים קטנים.
דרישות :
- Python
מגבלות :
-
GCW לא יכול לבטא את כל הסימון האפשרי בMarkdown. משמעות הדבר היא קבצי מקור Markdown צריכים להיות כתובים במגבלות הבאות בחשבון.
- משמשים לקישורים או מקורות תמונה צריכים להיות מוחלטים וחייבים להיות פרוטוקול ספציפי כדי לקבל הוכר על ידי GCW. בפרט, כל כתובת אתר חייבת להתחיל עם http: //, https: //, או ftp: //. Markowik ביטולי הגיור אם הוא מוצא את כתובות האתרים שאינם תואמים את הדרישות הללו.
- Typefacing בשמות Link:
- GCW אינו תומך typefacing בקישור שמות. לדוגמא GCW הופך את שם הקישור ב[ http://foo.com _Foo_], פשוטו כמשמעו, כלומר כ_Foo_. עם זאת, GCW מכיר typefacing בקישורי HTML, כלומר & lt; a href = & quot; http: //foo.com" & Gt; _Foo_ & lt; / & Gt; יודגש כראוי. לקישורי Markdown סיבה זו עם typefacing מקונן כמו [* Foo *] (http://foo.com) יומר לקישורי HTML. כתוצאה מכך, קישור תוויות עם תווים מיוחדים מסוימים שצריכים להיות נמלט בGCW באמצעות backtick (`) סמנים גם לגרום קישורי HTML.
- מקונן סעיפים:
- GCW לא ממש תומך בסעיפים מקוננים מרובים (למשל ברשימות או blockquotes). Markowik מדמה סעיפים מקוננים מרובים על ידי פרדה ב& lt; br / & gt; (שויזואלית סעיפים מחקה אבל לא לשבור את סביבת הקינון).
- תמונות:
- Markdown מאפשר להביע טקסטים חלופיים וכותרת לתמונות. תחביר התמונה של GCW אינו תומך בזה. הדרך היחידה לשמר את הטקסטים האלה היא להשתמש ב- HTML & lt רגילים; img & gt; תגים. אפשרות --html-תמונות מאפשרת פתרון זה.
- בעיה נוספת היא שGCW מצפה כתובות אתר של תמונות לסיים עם סיומת סוג קובץ תמונה. Markowik מוסיף סיומות תמונה מלאכותיות במידת צורך, לדוגמא http://foo.bar/image משתנה לhttp://foo.bar/image?x=x.png.
- קיצורים:
- יש GCW אין סימון לקיצורים ואינו תומך בתג & lt HTML; abbr & gt ;. Markowik ממיר קיצורים אל & lt; span & gt; -elements איזה סוג של קיצורים מחקה (באופן מוגבל כמובן) .
- HTML:
- כל-HTML רגיל המתרחש במקור Markdown סופו של דבר, פשוטו כמשמעו, בGCW (למעט התוכן של תגים ברמת span). משמעות הדבר היא מקור Markdown צריך להכיל HTML נתמך על ידי GCW בלבד. השלכה נוספת היא שכתובות אתרים המשמשים בתגי HTML רגילים אינן נבדקות לתאימות GCW. במילים אחרות: בעת שימוש ב- HTML גלם אתה בעצמך !
כתובות אתרים
תגובות לא נמצא