vimdown

vimdown on likainen työkalu muuntaa .vimrc ja .vim skripti tiedostoja markdown.
Asenna
Helpoin tapa asentaa on käyttää PIP
Pip asentaa vimdown
Tai voit valita asentaa ladata GitHub
Yleistä
Vimdown muuntaa .vim tiedostoja markdown asiakirjoja.
Vimdown syntyi hinku tehdä minun .vimrc hyvältä kuin README.mkd tiedosto minun GitHub arkistoon, joka pitää minun .vim hakemistoon.
Tämä README kirjoitettiin vim tiedosto ja luovutettiin markdown kanssa vimdown.
Vimdown on hyvin yksinkertainen jäsennin. Kaikki se on erillinen Vim tiedosto lohkoiksi tekstiä, joka joko vierekkäin kommentteja tai vierekkäisellä ei-kommentteja. Lohkot kommentteja riisuttu kommentti tavaramerkkien '' ', mistä aloittamalla linjan ja katsotaan olevan markdown syntaksin. Non-kommentti lohkot pidetään koodilauseita ja työnnetään tuloksena markdown asiakirjan nimenomaisen vim codeblocks. Vain linjat kommentin merkki, "" ", kuten ensimmäinen tai toinen merkki linjan katsotaan kommentteja. Jos kommentin merkki alkaa myöhemmin linja sitä pidetään koodia kommentin koodilohkon.
Käyttö
Vimdown on rakennettu apua lähtö
> Vimdown help
Perustiedot
Yksinkertaisesti antaa vimdown komento tiedostot on käsitellä ja se tulostaa tuloksen stdout:
> Vimdown infile> outfile
Voit määrittää tulostetiedostoa:
> Vimdown -o outfile infile
Useiden lähdetiedostosta:
> Vimdown infile infile2 infile3 -o outfile
Lisäasetukset
Markdown2 koodilauseita
Voit markdown2 tyyliin koodilauseita -C:
> Vimdown -c -o outfile infile
Se luo koodin lohkojen markdown tyyliin:
& Nbsp; ::: vim
& Nbsp; koodi on täällä
Render HTML
Jos olet markdown2 asentanut voit pyytää vimdown tehdä markdown HTML sinulle -t vaihtoehto.
Tämä helpottaa perus markdown dokumentin HTML outfile
> Vimdown -t -o outfile infile
Tämä helpottaa markdown asiakirjan markdown2 codeblocks kuin HTML outfile
> Vimdown -c -t -o outfile infile
Pygments Styles
Jos sinulla on sekä Markdown2 ja Pygments asennettu voit vimdown tehdä lähtö HTML-asiakirjan koodin markup tyylistä Pygments. Käytä -p vaihtoehto:
> Vimdown -p -o outfile infile
Esimerkkejä
Jos haluat nähdä reaalimaailman käyttöä vimdown, kassalle README varten Viming-With-Buttars projekti.
Kaikki mitä olet nähnyt dokumentin toistaiseksi on esimerkki siitä, miten vimdown tekee huomautuksia vim tiedosto.
Kommentti lohkot on oltava "" "kommentin merkki ensimmäisen tai toisen merkin linjan paikan.
Kommenttilohkon:
"# Kommentti
"_comment_
"Kommentti
kostan kuten:
kommentti
kommentti
kommentti
Toinen kommentti lohko, kommentti alkaa lisätilaa:
& Nbsp; "[kommentti] (http://google.com)
& Nbsp; "kommentti
& Nbsp; "__comment__
tekee kuten:
kommentti
kommentti
kommentti
Tämä katsotaan koodieston:
& Nbsp; "[kommentti] (http://google.com)
& Nbsp; "# kommentti
& Nbsp; "kommentti
kääntää myös:
& Nbsp; "[kommentti] (http://google.com)
& Nbsp; "# kommentti
& Nbsp; "kommentti
Seuraavat esimerkit ovat, miten se tehdä koodi lohkoja.
jos muuttuja <10
& Nbsp; anna g: muuttuja = 0
endif
Koodieston kommentteja
jos filereadable (TSTR)
& Nbsp; "varmista meidän iso perse BSD tagitiedostosta
& Nbsp; "käytetään subdirs samoin.
& Nbsp; joukko tageja + = TSTR "kommentti linjan päähän
endif