vimdown

vimdown er en skitten verktøy for å konvertere .vimrc og .vim skriptfiler til Markdown.
Installer
Den enkleste måten å installere er å bruke pip
PIP installere vimdown
Eller du kan velge en installere nedlasting fra GitHub
Oversikt
Vimdown forvandler .vim filer til Markdown dokumenter.
Vimdown ble født ut av en kløe å gjøre mine .vimrc ser fint som README.mkd fil for min GitHub depot som holder min .vim katalogen.
Denne README ble skrevet som en vim fil og gjengis til Markdown med vimdown.
Vimdown er en veldig enkel parser. Alt den gjør er seperate et Vim-filen inn i blokker med tekst som enten sammenhengende kommentarer eller sammenhengende ikke-kommentarer. Blokker av kommentarer er fratatt sine kommentartegn, "", fra begynnelsen av linjen, og anses å være i Markdown syntaks. Non-kommentar blokker anses kodeblokker og er satt inn den resulterende Markdown dokumentet som eksplisitte Vim codeblocks. Only linjer med kommentaren mark, "", som den første eller andre tegn på linje anses kommentarer. Hvis kommentaren mark starter senere i linjen vil det bli vurdert kode med en kommentar i koden blokken.
Bruk
Vimdown har innebygd hjelp utgang
> Vimdown --help
Grunnleggende
Bare gi den vimdown kommandoen en fil eller filer til å behandle og det vil skrive ut resultatet til stdout:
> Vimdown infile> outfile
Du kan spesifisere en output file:
> Vimdown -o outfile infile
Bruke flere innspill filer:
> Vimdown infile infile2 infile3 -o outfile
Avansert
Markdown2 kodeblokker
Du kan ha markdown2 stil kodeblokker med -c:
> Vimdown -c -o outfile infile
Som vil skape kode blokker i Markdown i stil med:
& Nbsp; ::: vim
& Nbsp; kode er her
Render til HTML
Hvis du har markdown2 installert kan du be vimdown å gjengi den markdown til HTML for deg med valget -t.
Dette vil gi en grunnleggende markdown dokument som HTML inn i outfile
> Vimdown -t -o outfile infile
Dette vil gi en markdown dokument med markdown2 codeblocks som HTML inn i outfile
> Vimdown -c -t -o outfile infile
Pygments Styles
Hvis du har både Markdown2 og Pygments installert, kan du ha vimdown gjengi resultatet som et HTML-dokument med koden markup stylet for Pygments. Bruke p-alternativet:
> Vimdown -p -o outfile infile
Eksempler
Å se reell bruk av vimdown, kassa README for Viming-With-Buttars prosjekt.
Alt du har sett i dokumentet så langt er et eksempel på hvordan vimdown gjengir kommentarer i en vim fil.
Kommentar blokker må ha '»' kommentar mark i den første eller andre tegnposisjon av linjen.
Kommentaren blokk:
"# Kommentar
"_comment_
"Kommentar
vil gjengi som:
kommentar
kommentar
kommentar
En annen kommentar blokk, starter kommentaren i en ekstra plass:
& Nbsp; "[kommentar] (http://google.com)
& Nbsp; "kommentar
& Nbsp; "__comment__
gjengir som:
kommentar
kommentar
kommentar
Dette vil bli betraktet som en kodeblokk:
& Nbsp; "[kommentar] (http://google.com)
& Nbsp; "# kommentar
& Nbsp; "kommentar
gjengitt som:
& Nbsp; "[kommentar] (http://google.com)
& Nbsp; "# kommentar
& Nbsp; "kommentar
De følgende eksempler på hvordan det vil gjengi kodeblokker.
hvis variabel <10
& Nbsp; la g: variabel = 0
endif
En kodeblokk med kommentarer
hvis filereadable (tstr)
& Nbsp; "sørge for at vår store ass BSD tags fil
& Nbsp; "er brukt i underkataloger også.
& Nbsp; sett koder + = tstr "kommentar på slutten av linjen
endif

Krav :

• Python