vimdown

vimdown is een vuile hulpmiddel om .vimrc en .vim script bestanden te converteren naar afwaardering.
Installeer
De makkelijkste manier om te installeren is door pip gebruiken
pip installeren vimdown
Of je kunt kiezen een installatie te downloaden van GitHub
Overzicht
Vimdown transformeert .vim bestanden in markdown documenten.
Vimdown werd geboren uit een jeuk om mijn .vimrc zien er leuk uit als de README.mkd bestand voor mijn GitHub repository dat mijn .vim directory bevat.
Deze README werd geschreven als een vim bestand en bewezen aan Markdown met vimdown.
Vimdown is een zeer eenvoudige parser. Alles wat het doet is apart een Vim bestand in blokken tekst die ofwel aaneengesloten opmerkingen of aaneengesloten niet-opmerkingen. Blokken van commentaar wordt ontdaan van hun reactie merken, '' ', uit het begin van de lijn en geacht in Markdown syntax. Non-commentaar blokken worden beschouwd code blokken en in de resulterende markdown document als expliciete vim codeblocks worden ingevoegd. Alleen lijnen met de reactie merk, '' ', als eerste of tweede teken van de lijn worden beschouwd opmerkingen. Als de reactie merk later in de lijn zal worden beschouwd code met een commentaar in de code blok begint.
Gebruik
Vimdown heeft ingebouwde help-uitgang
> Vimdown --help
Fundamenteel
Geef gewoon de vimdown commando een bestand of bestanden te verwerken en het zal uit het resultaat naar stdout af te drukken:
> Vimdown infile> outfile
U kunt een output bestand op te geven:
> Vimdown -o outfile infile
Met behulp van multiple input bestanden:
> Vimdown infile infile2 infile3 -o outfile
Geavanceerd
Markdown2 code blokken
U kunt markdown2 stijl code blokken met -c hebben:
> Vimdown -c -o outfile infile
Dat zal de code blokken te creëren in de afwaardering in de stijl van:
& Nbsp; ::: vim
& Nbsp; code is hier
Render naar HTML
Als u hebt markdown2 geïnstalleerd kunt u vragen vimdown de Markdown naar HTML te maken voor u met de -t optie.
Dit moet een basis markdown document als HTML te maken in de outfile
> Vimdown -t -o outfile infile
Dit zal een afwaardering document met markdown2 codeblocks als HTML in de outfile maken
> Vimdown -c -t -o outfile infile
Pygments Styles
Als u zowel Markdown2 en Pygments geïnstalleerd die je kunt hebben vimdown maken de output als een HTML-document met de code markup gestyled voor Pygments. Gebruik de optie -p:
> Vimdown -p -o outfile infile
Voorbeelden
Om echte wereld gebruik van vimdown zien, de kassa van de README voor de Viming-Met-Buttars project.
Alles wat je hebt gezien in het document tot nu toe is een voorbeeld van hoe vimdown maakt opmerkingen in een vim bestand.
Commentaarblokken moet de '' 'comment merk hebben in de eerste of tweede teken positie van de lijn.
De reactie blok:
"# Reactie
"_comment_
"Comment
zal zo maken:
commentaar
commentaar
commentaar
Nog een reactie achterlaten blok, de reactie begint in een extra ruimte:
& Nbsp; "[reactie] (http://google.com)
& Nbsp; "comment
& Nbsp; "__comment__
renders als:
commentaar
commentaar
commentaar
Dit wordt beschouwd als een code blok:
& Nbsp; "[reactie] (http://google.com)
& Nbsp; "# reactie
& Nbsp; "comment
weergegeven als:
& Nbsp; "[reactie] (http://google.com)
& Nbsp; "# reactie
& Nbsp; "comment
De volgende voorbeelden zijn hoe deze code blokken zal maken.
als variabele <10
& Nbsp; laat g: variabele = 0
endif
Een code blok met commentaar
Als filereadable (TSPR)
& Nbsp; "ervoor zorgen dat onze grote kont bsd-tags bestand
& Nbsp; "wordt gebruikt in de submappen ook.
& Nbsp; set-tags + = TSPR "commentaar op het einde van de lijn
endif

Eisen

• Python