vimdown

vimdown är en smutsig verktyg för att konvertera .vimrc och .vim skriptfiler till markdown.
Installera
Det enklaste sättet att installera är att använda pip
Pip installera vimdown
Eller du kan välja en installations nedladdning från GitHub
Översikt
Vimdown förvandlar .vim filer till markdown dokument.
Vimdown föddes ur en klåda att göra mina .vimrc ser trevligt som README.mkd filen för min GitHub slutförvar som håller min .vim katalog.
Denna README skrevs som en vim fil och återges till markdown med vimdown.
Vimdown är en mycket enkel parser. Allt det gör är separat en Vim fil i textblock som antingen angränsande kommentarer eller angränsande icke-kommentarer. Block av kommentarer är fråntagen sina kommentarmarkeringar, '"', från början av linjen och anses vara i markdown syntax. Icke-kommentarblocken anses kodblock och infogas i den resulterande markdown dokumentet som explicita VIM codeblocks. Endast linjer med kommentaren märket '"', som den första eller andra tecknet i raden anses kommentarer. Om kommentarsmarkering startar senare i linje den kommer att betraktas kod med en kommentar i kodblock.
Användning
Vimdown har inbyggda hjälputgång
> Vimdown --help
Grundläggande
Helt enkelt ge kommandot vimdown en eller flera filer att bearbeta och det kommer att skriva ut resultatet till stdout:
> Vimdown infil> outfile
Du kan ange en utfil:
> Vimdown -o utfil infil
Använda flera indatafiler:
> Vimdown infil infile2 infile3 -o utfil
Avancerat
Markdown2 kodblock
Du kan ha markdown2 stil kodblock med -c:
> Vimdown -c -o utfil infil
Det kommer att skapa kodblock i markdown i stil med:
& Nbsp; ::: vim
& Nbsp; kod är här
Render till HTML
Om du har markdown2 installerat kan du be vimdown att göra markdown till HTML för dig med -t alternativet.
Detta kommer att göra en grundläggande markdown-dokument som HTML i outfile
> Vimdown -t -o utfil infil
Detta kommer att göra en markdown-dokument med markdown2 codeblocks som HTML till outfile
> Vimdown -c -t -o utfil infil
Pygments Styles
Om du har både Markdown2 och Pygments installerade kan du vimdown göra produktionen som ett HTML-dokument med koden uppmärkning stylad för Pygments. Använd alternativet -p:
> Vimdown -p -o utfil infil
Exempel
För att se verkliga världen användning av vimdown, kassan README för Viming-Med-Buttars projektet.
Allt du har sett i dokumentet hittills är ett exempel på hur vimdown gör kommentarer i en vim fil.
Kommentera block måste ha '"' kommentarsmarkering i den första eller andra teckenpositionen av linjen.
Den kommentaren block:
"# Kommentar
"_comment_
"Kommentar
kommer att göra så:
kommentar
kommentar
kommentar
En annan kommentar blocket börjar kommentaren i en extra utrymme:
& Nbsp; "[kommentar] (http://google.com)
& Nbsp; "kommentar
& Nbsp; "__comment__
återger som:
kommentar
kommentar
kommentar
Detta kommer att betraktas som ett kodblock:
& Nbsp; "[kommentar] (http://google.com)
& Nbsp; "# kommentar
& Nbsp; "kommentar
återges som:
& Nbsp; "[kommentar] (http://google.com)
& Nbsp; "# kommentar
& Nbsp; "kommentar
Följande exempel är hur det kommer att se kodblock.
Om variabel <10
& Nbsp; låt g: variabel = 0
endif
En kod block med kommentarer
om filereadable (tstr)
& Nbsp; "se till att vår stora ass BSD taggar fil
& Nbsp; "används i underkataloger samt.
& Nbsp; set taggar + = tstr "kommentaren i slutet av raden
endif

Krav :

• Python