vimdown

vimdown είναι ένα βρώμικο εργαλείο για να μετατρέψετε .vimrc και .vim αρχεία δέσμης ενεργειών για markdown.
Εγκατάσταση
Ο ευκολότερος τρόπος για να εγκαταστήσετε είναι να χρησιμοποιήσετε pip
Pip εγκαταστήσετε vimdown
Ή μπορείτε να επιλέξετε μια εγκατάσταση λήψης από το GitHub
Επισκόπηση
Vimdown μετατρέπει .vim αρχεία σε έγγραφα markdown.
Vimdown γεννήθηκε από μια φαγούρα να κάνουν .vimrc μου φαίνονται ωραία, όπως το αρχείο README.mkd για GitHub αποθήκη μου που κρατά .vim κατάλογο μου.
Αυτό το αρχείο README γράφτηκε ως ένα αρχείο vim και παραδόθηκε σε Markdown με vimdown.
Vimdown είναι ένα πολύ απλό πρόγραμμα ανάλυσης. Το μόνο που κάνει είναι ανεξάρτητη μια Vim αρχείο σε τμήματα του κειμένου που είτε συνεχόμενα σχόλια ή συνεχόμενα μη-σχόλια. Μπλοκάρει των παρατηρήσεων απογυμνωθεί από τα σήματα σχόλιό τους, '"' Από την αρχή της γραμμής και θεωρείται ότι είναι σε σύνταξη markdown. Μπλοκ Μη σχόλιο θεωρούνται μπλοκ κώδικα και εισάγεται στο έγγραφο που προκύπτει markdown ως ρητή codeblocks vim. Μόνο Οι γραμμές με το σήμα σχόλιο, "", ως πρώτο ή δεύτερο χαρακτήρα της γραμμής θεωρούνται σχόλια. Αν το σχόλιο σήμα ξεκινά αργότερα στη γραμμή θα θεωρηθεί κώδικα με ένα σχόλιο στο μπλοκ κώδικα.
Χρήση
Vimdown έχει ενσωματωμένη βοήθεια εξόδου
> Vimdown --help
Βασικός
Απλά δώστε την εντολή vimdown ένα ή περισσότερα αρχεία για την επεξεργασία και θα εκτυπώσει το αποτέλεσμα στο stdout:
> Vimdown infile> outfile
Μπορείτε να καθορίσετε ένα αρχείο εξόδου:
> Vimdown -o outfile infile
Χρησιμοποιώντας πολλαπλά αρχεία:
> Vimdown infile infile2 infile3 -o outfile
Για προχωρημένους
Μπλοκ Markdown2 κώδικα
Μπορείτε να έχετε τον κωδικό μπλοκ στυλ markdown2 με -c:
> Vimdown -c -o outfile infile
Αυτό θα δημιουργήσει μπλοκ κώδικα στο markdown στο στυλ του:
& Nbsp? ::: Vim
& Nbsp? Κώδικας είναι εδώ
Render σε HTML
Εάν έχετε εγκαταστήσει markdown2 μπορείτε να ζητήσετε vimdown να καταστήσει το markdown σε HTML για σας με την επιλογή -t.
Αυτό θα καταστήσει ένα βασικό έγγραφο markdown ως HTML στο outfile
> Vimdown -t -o outfile infile
Αυτό θα καταστήσει ένα έγγραφο markdown με markdown2 codeblocks ως HTML στο outfile
> Vimdown -c -t -o outfile infile
Στυλ Pygments
Αν έχετε δύο Markdown2 και Pygments εγκατασταθεί μπορείτε να έχετε vimdown καταστήσει την έξοδο ως ένα έγγραφο HTML με τον κωδικό σήμανσης στυλ για Pygments. Χρησιμοποιήστε την επιλογή -p:
> Vimdown -p -o outfile infile
Παραδείγματα
Για να δείτε την πραγματική χρήση κόσμο του vimdown, ταμείο το αρχείο README για το έργο Viming-Με-Buttars.
Ό, τι έχετε δει στο έγγραφο μέχρι στιγμής είναι ένα παράδειγμα του πώς vimdown καθιστά σχόλια σε ένα αρχείο του vim.
Σχόλιο μπλοκ πρέπει να έχουν το "" σημάδι σχολίου στην πρώτη ή τη δεύτερη θέση χαρακτήρα της γραμμής.
Το σχόλιο μπλοκ:
"# Σχόλιο
"_comment_
"Σχόλιο
θα αποδοθεί ως:
σχόλιο
σχόλιο
σχόλιο
Ένα άλλο σχόλιο μπλοκ, το σχόλιο ξεκινά σε ένα επιπλέον χώρο:
& Nbsp? "[Σχόλιο] (http://google.com)
& Nbsp? "Σχόλιο
& Nbsp? "__comment__
καθιστά ως:
σχόλιο
σχόλιο
σχόλιο
Αυτό θα πρέπει να θεωρηθεί ως τμήμα κώδικα:
& Nbsp? "[Σχόλιο] (http://google.com)
& Nbsp? "# Σχόλιο
& Nbsp? "Σχόλιο
καθίσταται ως εξής:
& Nbsp? "[Σχόλιο] (http://google.com)
& Nbsp? "# Σχόλιο
& Nbsp? "Σχόλιο
Τα ακόλουθα παραδείγματα είναι πώς θα καταστήσει μπλοκ κώδικα.
αν η μεταβλητή <10
& Nbsp? Ας g: μεταβλητή = 0
endif
Ένα μπλοκ κώδικα με σχόλια
αν filereadable (tstr)
& Nbsp? ", Βεβαιωθείτε μεγάλο κώλο αρχείο ετικέτες BSD μας
& Nbsp? "Χρησιμοποιείται σε υποδιευθύνσεις, καθώς και.
& Nbsp? Σετ ετικέτες + = tstr "σχόλιο στο τέλος της γραμμής
endif

Απαιτήσεις :

• Python