vimdown

vimdown este un instrument murdar pentru a converti .vimrc și script .vim fișiere de reduceri.
Instalare
Cel mai simplu mod de a instala este de a folosi pip
Pip instala vimdown
Sau puteți alege un instala descărcare de la GitHub
Prezentare generală
Vimdown transformă .vim fișiere în documente Markdown.
Vimdown sa născut dintr-o mâncărime de a face .vimrc-mi arate frumos ca dosarul README.mkd de depozit meu GitHub care deține director mea .vim.
Acest README a fost scris ca un fișier vim și prestate reduceri cu vimdown.
Vimdown este un parser foarte simplu. Tot ce face este separat un fișier Vim în blocuri de text care fie observații învecinate sau adiacente non-comentarii. Blocuri de comentariile sunt eliminate mărcilor lor comentariu, "", de la inceputul liniei și considerat a fi în sintaxă reduceri. Blocuri de non-comentariu sunt considerate blocuri de cod și sunt introduse în documentul reduceri rezultat ca codeblocks vim explicite. Numai linii cu comentarii mărcii, "", ca primul sau al doilea caracter al liniei sunt considerate comentarii. În cazul în care marca comentariu începe mai târziu în linia se va considera cod cu un comentariu în blocul de cod.
Utilizare
Vimdown a construit în ajutor ieșire
> Vimdown help
De bază
Pur și simplu da comanda vimdown un fișier sau fișiere pentru a procesa si va imprima rezultatul la stdout:
> Vimdown infile> outfile
Puteți specifica un fișier de ieșire:
> Vimdown -o outfile infile
Folosind mai multe fișiere de intrare:
> Vimdown infile infile2 infile3 -o outfile
Avansat
Blocuri cod Markdown2
Puteți avea stil markdown2 blocuri de cod cu -c:
> Vimdown -c -o outfile infile
Acest lucru va crea blocuri de cod în reduceri în stilul de:
& Nbsp; ::: vim
& Nbsp; cod este aici
Render la HTML
Dacă ați instalat markdown2 puteți cere vimdown pentru a face reduceri pentru HTML pentru tine, cu opțiunea -t.
Acest lucru va face un document de reduceri de bază ca HTML în outfile
> Vimdown -t -o outfile infile
Acest lucru va face un document reduceri cu codeblocks markdown2 ca HTML în outfile
> Vimdown -c -t -o outfile infile
Pygments Stiluri
Dacă aveți atât Markdown2 și Pygments instalat, puteți avea vimdown face ieșire ca un document HTML cu codul marcajul stil de Pygments. Utilizați opțiunea -p:
> Vimdown -p -o outfile infile
Exemple
Pentru a vedea lumea reală de utilizare a vimdown, checkout README pentru proiectul Viming-cu-Buttars.
Tot ceea ce am văzut în documentul măsura este un exemplu de cum vimdown face observații într-un fișier Vim.
Comentariu blocuri trebuie să aibă "" "comentariu marca în prima sau a doua poziție caracter al liniei.
Blocul comentariu:
"# Comentariu
"_comment_
"Comentariu
va face ca:
comentariu
comentariu
comentariu
Un alt comentariu bloc, comentariu incepe intr-un spatiu suplimentar:
& Nbsp; "[comentariu] (http://google.com)
& Nbsp; "comentariu
& Nbsp; "__comment__
redă ca:
comentariu
comentariu
comentariu
Acest lucru va fi considerat un bloc de cod:
& Nbsp; "[comentariu] (http://google.com)
& Nbsp; "# comentariu
& Nbsp; "comentariu
randat ca:
& Nbsp; "[comentariu] (http://google.com)
& Nbsp; "# comentariu
& Nbsp; "comentariu
Următoarele exemple sunt cum va face blocuri de cod.
dacă variabila <10
& Nbsp; permite g: variabila = 0
endif
Un bloc de cod cu observații
dacă filereadable (tstr)
& Nbsp; "asigurați-vă că fundul mare dosar nostru de Tag-uri BSD
& Nbsp; "este folosit în mape de asemenea.
& Nbsp; set de Tag-uri + = tstr "comentariu la sfârșitul liniei
endif

Cerințe :

• Python