redtape

redtape είναι μια εστιασμένη γεννήτρια έγγραφο που χρησιμοποιεί github αρωματισμένο markdown να δημιουργήσει απλό, ελκυστικό έγγραφα HTML. Ενσωματώνει αυτόματα με twitter εκκίνησης και διαθέτει απλό, ελκυστικό στυλ. redtape είναι εμπνευσμένη από d, αλλά προσπαθεί να έχει ένα απλό interface, ενώ εξακολουθεί να επιτρέπει στους χρήστες να το στυλ και να ελέγχουν τα έγγραφα εξόδου τους σε υψηλό βαθμό παραμετροποίησης.
Εγκατάσταση
Αν είστε σε Linux ή OSX, που μπορείτε να χρησιμοποιήσετε για να εγκαταστήσετε PIP:
> PIP εγκαταστήσετε redtape
Το οποίο θα εγκαταστήσει redtape και τις εξαρτήσεις του.
Χρήση
Για να χρησιμοποιήσετε, τρέξιμο RT σε ένα έγγραφο ή κατάλογο γεμάτο με έγγραφα. Αν τρέχει σε έναν κατάλογο, RT θα δημιουργήσει HTML αρχεία για κάθε αρχείο markdown (.md, .mdown, ή .markdown επεκτάσεις):
> Rt mydocument.md
> Τεκμηρίωση rt /
περιουσιακών στοιχείων
Από προεπιλογή, RT αναλαμβάνει έχετε δημιουργήσει μια θέση για να εξυπηρετήσει τα αρχεία από τα οποία έχουν τα περιουσιακά στοιχεία που rt συνδέσεις σε αυτά τα έγγραφα. Η διάταξη είναι ακριβώς το ίδιο με τον κατάλογο περιουσιακών στοιχείων στο χώρο αποθήκευσης redtape: / περιουσιακά στοιχεία / {CSS, img, js} / .. για κάθε περιουσιακό στοιχείο που θα χρησιμοποιήσετε. Αν θέλετε να χρησιμοποιήσετε τις προεπιλεγμένες περιουσιακά στοιχεία redtape, μπορείτε εύκολα να δημιουργήσετε ένα κατάλληλο κατάλογο περιουσιακών στοιχείων στον τρέχοντα κατάλογο και εκτελώντας:
> RT---create περιουσιακά στοιχεία
Αν τρέχετε σε λειτουργία ενός εγγράφου ή δεν επιθυμούν να δημιουργήσουν έναν κατάλογο των περιουσιακών στοιχείων για την ενδεχόμενη υποδοχής για έγγραφα HTML σας, μπορείτε να πείτε redtape να ενσωματώσετε κάθε περιουσιακό στοιχείο που χρησιμοποιείται σε ένα έγγραφο χρησιμοποιώντας --embed:
> Rt --embed mydocument.md
javascript
Από προεπιλογή, redtape δεν απαιτεί καμία JavaScript για να λειτουργήσει, και δεν θα ενσωματώσει οποιαδήποτε --embed σε λειτουργία. Εάν επιλεγεί η --prettify επιλογή, θα πρέπει να χρησιμοποιηθούν εξωραΐζουν βιβλιοθήκη της Google για την πηγή τονίζοντας αντί pygments, και αν --prettify και οι δύο χρησιμοποιούνται και --embed, θα ενσωματώνονται αυτόματα.
Redtape είναι επίσης κατάλληλες για την απλή μίας σελίδας διαδηλώσεις javascript, και αν --Χρησιμοποιήστε-JS είναι ενεργοποιημένη, redtape θα περιλαμβάνουν jQuery και βιβλιοθήκες javascript εκκίνησης του.
την προσαρμογή της παραγωγής
Προσαρμογή εξόδου είναι εύκολο να γίνει σε μια ποικιλία τρόπων. Εκτός από την αλλαγή του CSS περιουσιακού στοιχείου για μη ενσωματωμένα έγγραφα, μπορείτε επίσης να προσθέσετε κεφαλίδες και υποσέλιδα ή ακόμη και να χρησιμοποιήσετε προσαρμοσμένα πρότυπα εγγράφων που βασίζονται στο προεπιλεγμένο πρότυπο redtape του.
κεφαλίδες και υποσέλιδα
Εάν έχετε μια προσαρμοσμένη κεφαλίδα ή το υποσέλιδο του εγγράφου που θέλετε να προστίθενται στα έγγραφά σας, μπορείτε είτε να προσθέσετε header.html και footer.html έγγραφα στη βάση κατάλογο που καθιστούν ή ορίσετε προεπιλεγμένες διαδρομές που θα χρησιμοποιηθούν στο config ως κεφαλίδα και το υποσέλιδο. Από προεπιλογή, αυτές θα πρέπει να τοποθετούνται στο επάνω και στο κάτω μέρος του εγγράφου σας, αντίστοιχα.
Ένα σύνολο του δείγματος των εγγράφων που θα μπορούσαν να είναι:
> Ls mydocs /
mydocs / index.md mydocs / simple.md mydocs / advanced.md
mydocs / header.html mydocs / footer.html
Παροχή mydocs με RT mydocs θα χρησιμοποιήσει την κεφαλίδα και το υποσέλιδο για κάθε έγγραφο στον κατάλογο.
προσαρμοσμένα πρότυπα
Αν έχετε πολύ συγκεκριμένες απαιτήσεις, μπορείτε να γράψετε το δικό σας πρότυπο εγγράφου και να έχουν τον απόλυτο έλεγχο της παραγωγής. Redtape χρησιμοποιεί την μηχανή προτύπων jinja2, το οποίο είναι ένα ευρέως χρησιμοποιούμενο σύστημα προτυποποίησης παρόμοιο με Django πρότυπα. Εκτελέστε redtape με την --context επιχείρημα για να πάρετε μια σύντομη ιδέα για το τι μεταβλητές είναι διαθέσιμες στο πρότυπο.
Μπορείτε επίσης να κληρονομήσουν από basic.jinja, που είναι το όνομα του προεπιλεγμένο πρότυπο redtape του. Αυτό το πρότυπο ορίζει δύο μπλοκ, το κεφάλι και το σώμα, το οποίο θα σας επιτρέψει να δημιουργήσουν μια ξεχωριστή σώμα του εγγράφου, ενώ, για παράδειγμα, διατηρώντας τη βασική CSS και λειτουργικότητας JavaScript του redtape. Παρακάμπτοντας τα δύο θα σας αφήσει με μια τυπική δομή του εγγράφου HTML5.
Μπορείτε να καθορίσετε ένα προσαρμοσμένο πρότυπο για χρήση με το -t, --template ή τοποθετήστε το στον κατάλογο του εγγράφου ως custom.html ή custom.jinja

Απαιτήσεις :.

• Python