vimdown

vimdown là một công cụ để chuyển đổi vimrc bẩn và kịch bản vim file để markdown.
Cài đặt
Cách dễ nhất để cài đặt là sử dụng pip
pips cài đặt vimdown
Hoặc bạn có thể chọn một cài đặt tải về từ GitHub
Tổng quan
Vimdown biến vim tập tin vào tài liệu markdown.
Vimdown được sinh ra trong một ngứa để vimrc của tôi trông đẹp như các tập tin README.mkd cho kho GitHub của tôi chứa thư mục vim của tôi.
README này được viết như một tập tin vim và đưa cho Markdown với vimdown.
Vimdown là một cú pháp rất đơn giản. Tất cả nó là một file riêng biệt Vim vào các khối văn bản đó, hoặc bình luận tiếp giáp liền kề hoặc không có ý kiến. Blocks ý kiến ​​được tước hiệu bình luận của họ, '"', từ sự khởi đầu của dòng và được coi là trong cú pháp markdown. Khối không bình luận được coi là khối mã và được đưa vào tài liệu markdown kết quả như CodeBlocks vim rõ ràng. Chỉ dòng với dấu comment, '"', như là nhân vật đầu tiên hoặc thứ hai của dòng được coi là chú. Nếu nhãn hiệu bắt đầu bình luận sau đó trong dòng nó sẽ được coi là mã với một bình luận trong các khối mã.
Cách sử dụng
Vimdown đã được xây dựng để giúp đầu ra
> Vimdown --help
Căn bản
Đơn giản chỉ cần cung cấp cho các lệnh vimdown một tập tin hoặc các tập tin để xử lý và nó sẽ in ra kết quả để stdout:
> Vimdown infile> outfile
Bạn có thể chỉ định một tập tin đầu ra:
> Vimdown -o outfile Infile
Sử dụng nhiều dữ liệu đầu vào:
> Vimdown Infile infile2 infile3 -o outfile
Advanced
Khối Mã Markdown2
Bạn có thể có kiểu markdown2 Mã khối với -c:
> Vimdown -c -o outfile Infile
Điều đó sẽ tạo ra khối mã trong markdown trong phong cách của:
& Nbsp; ::: vim
& Nbsp; đang ở đây
Render để HTML
Nếu bạn đã cài đặt markdown2 bạn có thể hỏi vimdown để render các markdown để HTML cho bạn với tùy chọn -t.
Điều này sẽ làm cho một tài liệu cơ bản như HTML markdown vào outfile
> Vimdown -t -o outfile Infile
Điều này sẽ làm cho một tài liệu markdown với CodeBlocks markdown2 như HTML vào outfile
> Vimdown -c -t -o outfile Infile
Pygments Styles
Nếu bạn có cả Markdown2 và Pygments cài đặt, bạn có thể có vimdown làm cho đầu ra như là một tài liệu HTML với các đánh dấu mã số theo kiểu cho Pygments. Sử dụng tùy chọn -p:
> Vimdown -p -o outfile Infile
Ví dụ
Để xem sử dụng thế giới thực sự của vimdown, kiểm tra các README cho dự án Viming-Với-Buttars.
Tất cả mọi thứ bạn đã thấy trong các tài liệu cho đến nay là một ví dụ về cách vimdown ám ý kiến ​​trong một tập tin vim.
Khối bình luận phải có '"' đánh dấu comment ở vị trí ký tự đầu tiên hoặc thứ hai của dòng.
Các khối bình luận:
"# Comment
"_comment_
"Comment
sẽ làm như sau:
chú thích
chú thích
chú thích
Một khối bình luận, nhận xét bắt đầu trong một không gian mở rộng:
& Nbsp; "[comment] (http://google.com)
& Nbsp; "comment
& Nbsp; "__comment__
ám như:
chú thích
chú thích
chú thích
Điều này sẽ được coi là một khối mã:
& Nbsp; "[comment] (http://google.com)
& Nbsp; "# comment
& Nbsp; "comment
xuất như:
& Nbsp; "[comment] (http://google.com)
& Nbsp; "# comment
& Nbsp; "comment
Các ví dụ sau đây là làm thế nào nó sẽ làm cho khối mã.
nếu biến <10
& Nbsp; cho g: biến = 0
endif
Một khối mã với ý kiến
nếu filereadable (tstr)
& Nbsp; "chắc chắn lớn ass tags bsd tập tin của chúng tôi
& Nbsp; "được sử dụng trong subdirs là tốt.
& Nbsp; bộ thẻ + = tstr "bình luận ở cuối dòng
endif

Yêu cầu :

• Python