vimdown yra nešvarus įrankis konvertuoti .vimrc ir .vim skripto failus į sumažina jį.
Įdiegti
Paprasčiausias būdas įdiegti yra naudoti pip
PIP įdiegti vimdown
Arba galite pasirinkti įdiegti atsisiųsti iš GitHub
Apžvalga
Vimdown transformuoja .vim failus į markdown dokumentus.
Vimdown gimė iš niežulys, kad mano .vimrc gražiai atrodo kaip README.mkd failą mano GitHub saugykloje, kad turi mano .vim katalogą.
Tai README buvo parašyta kaip vim failą ir teikiamos reklamos kainos su vimdown.
Vimdown yra labai paprasta analizatorius. Visa tai daro, yra seperate Vim failą į teksto blokų, kuris pateikia gretimi pastabų ar gretimuose ne komentarai. Blokai komentarai yra atimta jų komentarą ženklų, "" ", nuo linijos pradžioje ir laikoma, kad reklamos kainos sintaksė. Ne komentarą blokai laikomi kodas blokai ir yra įtrauktas į gautą markdown dokumento, kaip aiškiai vim codeblocks. Tik linijos su pastaba ženklo "" ", kaip pirmos ar antros charakterio linijos yra laikomi komentarus. Jei komentaras ženklas prasideda vėliau eilutėje jis bus laikomas kodas su Kodekse bloko komentarą.
Naudojimas
Vimdown sukūrė Pagalba produkcijos
> Vimdown help
Pagrindinis
Tiesiog duoti vimdown komandą failą arba failus apdoroti ir jis bus išspausdinti į stdout rezultatas:
> Vimdown INFILE> outfile
Galite nurodyti išvesties failą:
> Vimdown -o outfile INFILE
Naudojant keletą įėjimo failus:
> Vimdown INFILE infile2 infile3 -o outfile
Išplėstinė
Markdown2 kodas blokai
Jūs galite turėti markdown2 stilius kodas blokus su -c:
> Vimdown -c -o outfile INFILE
Tai sukurs kodas blokus į stiliaus sumažina jį:
& Nbsp; ::: Vim
& Nbsp; kodas yra čia
Render HTML
Jei markdown2 įdiegta galite užduoti vimdown teikti į HTML reklamos kainos už jus su -t variantą.
Tai suteiks pagrindinę markdown dokumentą kaip HTML į outfile
> Vimdown -t -o outfile INFILE
Tai padaryti labai sumažina jį dokumentą markdown2 codeblocks kaip HTML į outfile
> Vimdown -c -t -o outfile INFILE
pygments Stiliai
Jei turite tiek Markdown2 ir pygments įdiegta galite turėti vimdown padaryti išėjimą kaip HTML dokumentą su kodu žymėjimo stiliaus už pygments. Naudokite -p variantą:
> Vimdown -p -o outfile INFILE
Pavyzdžiai
Norėdami pamatyti realaus pasaulio naudojimo vimdown, kasos už Viming-Su-Buttars projekto README.
Viskas ko jums mačiau dokumente šiol yra kaip vimdown teikia pastabas dėl vim failo pavyzdys.
Komentaras blokai turi turėti "" "komentuoti ženklą pirmą arba antrą simbolių pozicijos eilutėje.
Komentaras blokas:
"# Komentaras
"_comment_
"Komentaras
atpigs, nes:
komentaras
komentaras
komentaras
Kitas komentaras blokas, komentaras prasideda papildomą erdvę:
& Nbsp; "[komentaras] (http://google.com)
& Nbsp; "komentaras
& Nbsp; "__comment__
teikia kaip:
komentaras
komentaras
komentaras
Tai bus laikomas kodas blokas:
& Nbsp; "[komentaras] (http://google.com)
& Nbsp; "# komentaras
& Nbsp; "komentaras
teikiamos kaip:
& Nbsp; "[komentaras] (http://google.com)
& Nbsp; "# komentaras
& Nbsp; "komentaras
Toliau pateikiami pavyzdžiai yra kaip ji bus padaryti kodo blokus.
jei kintamasis <10
& Nbsp; tegul g: kintamasis = 0
endif
Kodas blokas su komentarais
jei filereadable (tstr)
& Nbsp; "įsitikinkite, kad mūsų didelis asilas bsd žymės failą
& Nbsp; "yra naudojamas subdirs taip pat.
& Nbsp; rinkinys žymės + = tstr "komentaras eilutės pabaigoje
endif
Reikalavimai :
- Python
Komentarai nerastas