vimdown

vimdown er en beskidt værktøj til at konvertere .vimrc og .vim script filer til markdown.
Installer
Den nemmeste måde at installere er at bruge pip
pip installere vimdown
Eller du kan vælge en installere downloades fra GitHub
Oversigt
Vimdown forvandler .vim filer i Markdown dokumenter.
Vimdown blev født ud af en kløe at gøre mine .vimrc ser nice som README.mkd fil til min GitHub repository, der holder min .vim mappe.
Denne README blev skrevet som en vim fil og gøres til nedskrivning af værdien med vimdown.
Vimdown er en meget enkel parser. Alt det gør, er seperat en Vim fil i blokke af tekst, enten tilstødende kommentarer eller tilstødende ikke-kommentarer. Blokke af kommentarer er frataget deres kommentar mærker, '' ", fra starter af linjen og anses for at være i markdown syntaks. Ikke-kommentar-blokke betragtes kodeblokke og indsættes i den resulterende markdown dokumentet som eksplicitte VIM codeblocks. Kun linjer med kommentaren mark, '' ", som den første eller anden karakter af linjen betragtes kommentarer. Hvis kommentar mærke starter senere i linjen det vil blive betragtet som kode med en kommentar i koden blok.
Anvendelse
Vimdown har indbygget hjælp output
> Vimdown --help
Grundlæggende
Du skal blot give vimdown kommandoen en eller flere filer til at behandle, og det vil udskrive resultatet til stdout:
> Vimdown infile> outfile
Du kan angive en output-fil:
> Vimdown -o outfile infile
Brug af flere input filer:
> Vimdown infile infile2 infile3 -o outfile
Avanceret
Markdown2 kodeblokke
Du kan have markdown2 stil kode blokke med -C:
> Vimdown -c -o outfile infile
Det vil skabe kodeblokke i markdown i stil med:
& Nbsp; ::: vim
& Nbsp; kode er her
Render til HTML
Hvis du har markdown2 installeret kan du bede vimdown at gøre markdown til HTML for dig med den -t mulighed.
Dette vil gøre en grundlæggende markdown dokument som HTML i outfile
> Vimdown -t -o outfile infile
Dette vil gøre en markdown dokument med markdown2 codeblocks som HTML til outfile
> Vimdown -c -t -o outfile infile
Pygments Styles
Hvis du har både Markdown2 og Pygments installeret kan du få vimdown gøre output som et HTML-dokument med koden markup stylet for Pygments. Brug -p mulighed:
> Vimdown -p -o outfile infile
Eksempler
For at se virkelige verden brug af vimdown, kassen README for Viming-med-Buttars projekt.
Alt, hvad du har set i dokumentet hidtil er et eksempel på, hvordan vimdown gør kommentarer i en vim fil.
Kommentar blokke skal have "" "kommentar mærke i position af linjen den første eller anden karakter.
Kommentaren blok:
"# Kommentar
"_comment_
"Kommentar
vil gøre som:
kommentar
kommentar
kommentar
En anden kommentar blok, starter kommentar i en ekstra plads:
& Nbsp; "[kommentar] (http://google.com)
& Nbsp; "kommentar
& Nbsp; "__comment__
gør som:
kommentar
kommentar
kommentar
Dette vil blive betragtet som en kodeblok:
& Nbsp; "[kommentar] (http://google.com)
& Nbsp; "# kommentar
& Nbsp; "kommentar
gengivet som:
& Nbsp; "[kommentar] (http://google.com)
& Nbsp; "# kommentar
& Nbsp; "kommentar
De følgende eksempler er, hvordan det vil gøre kodeblokke.
hvis variabel <10
& Nbsp; lad g: variabel = 0
endif
En kode blok med kommentarer
hvis filereadable (tstr)
& Nbsp; "at sikre vores store røv BSD tags fil
& Nbsp; "anvendes i undermapper som godt.
& Nbsp; sæt tags + = tstr "kommentar i slutningen af ​​linjen
endif

Krav :

• Python