vimdown הוא כלי מלוכלך כדי להמיר קבצי .vimrc ותסריט .vim לmarkdown.
תקן
הדרך הקלה ביותר להתקנה היא להשתמש פיפס
PIP להתקין vimdown
או שאתה יכול לבחור להתקין הורדה מGitHub
סקירה כללית
Vimdown הופך .vim קבצים לתוך מסמכי markdown.
Vimdown נולד מתוך גירוד לעשות .vimrc שלי נראה יפה כקובץ README.mkd למאגר GitHub שלי שמחזיק בספריית .vim שלי.
README זה נכתב כקובץ vim וניתן לMarkdown עם vimdown.
Vimdown הוא מנתח פשוט מאוד. האם כל זה הוא נפרד קובץ Vim לגושים של טקסט שגם הערות רציפות או בלתי רציפות הערות. בלוקים של הערות הופשטו מסימני התגובה שלהם, '"', מההתחלה של הקו ונחשבים בתחביר Markdown. בלוקים ללא תגובה נחשבים גושי קוד ומוכנסים לתוך מסמך markdown וכתוצאה מכך כcodeblocks vim המפורש. רק קווים עם הסימן '"," התגובה, כדמות הראשונה או שנייה של הקו נחשבים הערות. אם סימן התגובה מתחיל מאוחר יותר בקו זה ייחשב קוד עם תגובה בגוש הקוד.
שימוש
Vimdown בנה בתפוקת עזרה
> Vimdown --help
בסיסי
פשוט לתת את פקודת vimdown קובץ או קבצים לעבד וזה יהיה להדפיס את התוצאה ל stdout:
> Vimdown infile> outfile
באפשרותך לציין קובץ פלט:
> Vimdown -o outfile infile
שימוש בקבצי קלט מרובים:
> Vimdown infile infile2 infile3 -o outfile
מתקדם
גושי קוד Markdown2
אתה יכול לקבל בלוקים קוד בסגנון markdown2 עם -c:
> Vimdown -c -o outfile infile
שייצור גושי קוד בmarkdown בסגנון של:
& Nbsp; ::: vim
& Nbsp; קוד הוא כאן
Render לHTML
אם יש לך markdown2 מותקן אתה יכול לשאול vimdown כדי להבהיר markdown לHTML עבורך את אפשרות -t.
זה יהפוך את מסמך markdown בסיסי כמו HTML לתוך outfile
> Vimdown -t -o outfile infile
זה יהפוך את מסמך markdown עם codeblocks markdown2 כHTML לתוך outfile
> Vimdown -c -t -o outfile infile
סגנונות Pygments
אם יש לך שני Markdown2 וPygments מותקן אתה יכול לקבל vimdown להבהיר את הפלט כמסמך HTML עם סימון הקוד בסגנון לPygments. השתמש באפשרות -p:
> Vimdown -p -o outfile infile
דוגמאות
כדי לראות את השימוש בעולם אמיתי של vimdown, קופת README לפרויקט Viming-עם-Buttars.
כל מה שאתה ראית במסמך עד כה הוא דוגמא לאופן שvimdown הופך הערות בקובץ vim.
בלוקים תגובה חייבים להיות '"' סימן התגובה בעמדת התו הראשון או שנייה של הקו.
בלוק התגובה:
"# תגובה
"_comment_
"תגובה
יעבד כ:
תגובה
תגובה
תגובה
בלוק תגובה אחר, התגובה מתחילה בשטח נוסף:
& Nbsp; "[הערה] (http://google.com)
& Nbsp; הערה "
& Nbsp; __comment__ "
הופך כ:
תגובה
תגובה
תגובה
זה ייחשב גוש קוד:
& Nbsp; "[הערה] (http://google.com)
& Nbsp; "# תגובה
& Nbsp; הערה "
כפי שניתן:
& Nbsp; "[הערה] (http://google.com)
& Nbsp; "# תגובה
& Nbsp; הערה "
דוגמאות הבאות הן איך זה יהפוך את גושי קוד.
אם משתנה <10
& Nbsp; בוא g: משתנה = 0
endif
גוש קוד עם הערות
אם filereadable (tstr)
& Nbsp; "לוודא קובץ התחת הגדול שלנו תגי BSD
& Nbsp; "משמש בsubdirs גם כן.
תגובה תגי סט + = tstr "בסופו של קו; & nbsp
endif
דרישות :
- Python
תגובות לא נמצא