vimdown jest brudna narzędzie do konwersji .vimrc i .vim skryptów pliki do obniżki.
Zainstaluj
Najprostszym sposobem instalacji jest użycie pip
pip install vimdown
Albo możesz wybrać zainstalować pobieranie z GitHub
Informacje
Vimdown przekształca .vim plików do dokumentów przecen.
Vimdown narodził się z swędzenie, aby moje .vimrc wyglądają ładnie, jak plik README.mkd dla mojego repozytorium GitHub, która posiada moje .vim katalogu.
To README został napisany jako plik vim i oddawana Przecena z vimdown.
Vimdown jest bardzo prosty parser. Wszystko robi to indywidualne plików Vim na bloki tekstu, że albo ciągłych komentarzy lub sąsiadujących nie-komentarze. Bloki komentarze są pozbawione znaków komentarza, '"', od początku linii i uznane za składni wyprzedaży. Nie są uważane za bloki komentarz bloki kodu i są wstawiane do dokumentu wynikowego wyprzedaży jako wyraźnych CodeBlocks vim. Tylko linie ze znakiem komentarza, '"', jako pierwszego lub drugiego znaku w linii są uważane za komentarze. Jeśli znak zaczyna się później w komentarz linii zostanie uznane Kod z komentarzem w bloku kodu.
Zastosowanie
Vimdown ma wbudowane wyjście pomocy
> Vimdown --help
Podstawowy
Wystarczy wydać polecenie vimdown na przetwarzanie pliku lub plików i będzie wydrukować wynik na standardowe wyjście:
> Vimdown plik_we> plik_wy
Możesz określić pliku wyjściowego:
> Vimdown -o plik_wy plik_we
Korzystanie z wielu plików wejściowych:
> Vimdown plik_we infile2 infile3 -o plik_wy
Zaawansowane
Bloki kod Markdown2
Możesz mieć styl markdown2 bloki kodu z -c:
> Vimdown -c -o plik_wy plik_we
To stworzy bloki kodu w obniżki w stylu:
& Nbsp; ::: vim
& Nbsp; kod jest tutaj
Render HTML
Jeśli markdown2 zainstalowany możesz poprosić vimdown do renderowania przecen do HTML dla Ciebie z opcją -t.
Spowoduje to podstawowy dokument markdown jak HTML do outfile
> Vimdown -t -o plik_wy plik_we
Spowoduje to dokument markdown z markdown2 CodeBlocks jak HTML do tej outfile
> Vimdown -c -t -o plik_wy plik_we
Pygments Style
Jeśli masz oba Markdown2 i Pygments zainstalowany można mieć vimdown czyni wyjście jako dokument HTML z kodem stylu znaczników dla Pygments. Użyj opcji -p:
> Vimdown -p -o plik_wy plik_we
Przykłady
Aby zobaczyć prawdziwą światową vimdown użytkowania, kasy README dla projektu Viming-Z-Buttars.
Wszystko, co widziałem w dokumencie jakim jest przykładem tego, jak vimdown czyni komentarzy w pliku vim.
Komentarz bloki muszą mieć znak '"' komentarz w pierwszej lub drugiej pozycji znaków w linii.
Blok komentarz:
"# Komentarz
"_comment_
"Komentarz
będzie świadczyć, jak:
komentarz
komentarz
komentarz
Kolejny blok komentarza, komentarz zaczyna się w dodatkowej przestrzeni:
& Nbsp; "[Komentarz] (http://google.com)
& Nbsp; "komentarz
& Nbsp; "__comment__
świadczy, jak:
komentarz
komentarz
komentarz
To będą rozpatrywane blok kodu:
& Nbsp; "[Komentarz] (http://google.com)
& Nbsp; "# komentarz
& Nbsp; "komentarz
renderowane jako:
& Nbsp; "[Komentarz] (http://google.com)
& Nbsp; "# komentarz
& Nbsp; "komentarz
Poniższe przykłady są, jak to czynią bloki kodu.
gdy zmienna <10
& Nbsp; niech g: zmienna = 0
endif
Blok kodu z komentarzami
jeśli filereadable (tstr)
& Nbsp; "upewnić się, że nasz wielki tyłek plik tagów bsd
& Nbsp; "stosuje się w podkatalogów również.
& Nbsp; zestaw tagi + = tstr "komentarz na końcu linii
endif
Wymagania :
- Python
Komentarze nie znaleziono