vimdown

vimdown è uno strumento sporco per convertire i file .vimrc e script .vim di Markdown.
Installa
Il modo più semplice per installare è quello di utilizzare pip
pip installare vimdown
Oppure si può scegliere un install scaricare da GitHub
Descrizione
Vimdown trasforma .vim file in documenti di riduzione dei prezzi.
Vimdown nasce da un prurito per fare le mie .vimrc aspetto gradevole del file README.mkd per il mio repository GitHub che contiene la mia directory .vim.
Questo README è stato scritto come un file vim e reso di Markdown con vimdown.
Vimdown è molto semplice parser. Tutto ciò che fa è separato un file Vim in blocchi di testo che sia i commenti contigui o contigui non commenti. Blocchi di commenti sono spogliati dei loro marchi di commento, '"', dal l'inizio della linea e considerati nella sintassi Markdown. Non blocchi di commento sono considerati blocchi di codice e vengono inseriti nel documento Markdown risultante come codeblocks vim espliciti. Solo linee con il marchio commento, '"', come il primo o il secondo carattere della linea sono considerate commenti. Se il segno commento inizia successivamente nella linea sarà considerato codice con un commento nel blocco di codice.
Utilizzo
Vimdown ha costruito in uscita aiuto
> Vimdown --help
Di base
Basta dare il comando vimdown un file o file da elaborare e stampa il risultato a stdout:
> Vimdown infile> outfile
È possibile specificare un file di output:
> Vimdown -o outfile infile
L'utilizzo di più file di input:
> Vimdown infile infile2 infile3 -o outfile
Avanzate
Blocchi codice Markdown2
Si può avere stile markdown2 blocchi di codice con -c:
> Vimdown -c -o outfile infile
Questo creerà blocchi di codice in markdown in stile:
& Nbsp; ::: vim
& Nbsp; il codice è qui
rendering HTML
Se avete installato markdown2 si può chiedere vimdown per rendere il markdown in HTML per voi con l'opzione -t.
Questo renderà un documento Markdown base come HTML nella outfile
> Vimdown -t -o outfile infile
Questo renderà un documento Markdown con codeblocks markdown2 come HTML nel outfile
> Vimdown -c -t -o outfile infile
Stili Pygments
Se si dispone di Markdown2 e Pygments installati si può avere vimdown rendere l'uscita come un documento HTML con il markup codice stile per Pygments. Utilizzare l'opzione -p:
> Vimdown -p -o outfile infile
Esempi
Per vedere l'uso del mondo reale di vimdown, checkout il README per il progetto Viming-Con-Buttars.
Tutto quello che avete visto nel documento finora è un esempio di come vimdown rende i commenti in un file vim.
Commento blocchi devono avere il '"' commento segno nella prima o nella seconda posizione del carattere della linea.
Il blocco di commento:
"# Commento
"_comment_
"Commento
renderà come:
commento
commento
commento
Un altro blocco commento, il commento inizia in uno spazio in più:
& Nbsp; "[Commento] (http://google.com)
& Nbsp; "commento
& Nbsp; "__comment__
rende come:
commento
commento
commento
Questo sarà considerato un blocco di codice:
& Nbsp; "[Commento] (http://google.com)
& Nbsp; "# commento
& Nbsp; "commento
reso come:
& Nbsp; "[Commento] (http://google.com)
& Nbsp; "# commento
& Nbsp; "commento
Gli esempi che seguono sono come renderà blocchi di codice.
se la variabile <10
& Nbsp; lasciate g: variabile = 0
endif
Un blocco di codice con i commenti
se filereadable (tstr)
& Nbsp; "assicurarsi che il nostro grande file tag BSD culo
& Nbsp; "viene utilizzato in sottodirectory pure.
& Nbsp; tags set + = tstr "commento alla fine della linea
endif

Requisiti :

• Python