redtape

redtape basit, çekici HTML belgeleri oluşturmak için github aromalı Markdown kullanan odaklanmış bir belge jeneratör olduğunu. Otomatik olarak twitter bootstrap ile entegre ve basit, çekici stil sunuyor. redtape d esinlenerek, ama hala izin kullanıcıların stil ve özelleştirme yüksek derecede onların çıkış belgelerini kontrol etmek ise basit bir arayüze sahip dener.
Yükleme
Eğer linux veya OSX üzerinde iseniz, yüklemek için pip kullanabilirsiniz:
> Redtape yüklemek pip
Hangi redtape ve bağımlılıklarını kuracaktır.
Kullanım
Belgelerin tam bir belge veya dizin üzerine, çalışma rt kullanmak için. Bir dizinde çalıştırın, rt her markdown dosyası için html dosyaları (.md, .mdown veya .markdown uzantıları) yaratacaktır:
> Rt mydocument.md
> Rt belgeleri /
varlıklar
Varsayılan olarak, rt dosyaları hangi bu belgelere bağlantıları rt varlıkları hizmet için bir konum kurdunuz varsayar. düzeni tam olarak redtape deposunda varlıklar dizinindeki aynıdır: / varlık / {css, img, js} / .. kullanacağınız her varlık için. Eğer redtape varsayılan varlıklarını kullanmak istiyorsanız, kolayca çalıştırarak geçerli dizinde uygun bir varlık dizin oluşturabilirsiniz:
> Rt --create-varlıklar
Eğer tek bir belge modunda çalışan veya HTML belgeleri için nihai ana bilgisayarda bir varlık dizini kurmak istemiyorsanız, size --embed kullanarak bir belgede kullanılan her varlık gömmek için redtape söyleyebilirim:
> Oda sıcaklığı --embed mydocument.md
javascript
Varsayılan olarak, redtape çalıştırmak için herhangi bir javascript gerektirmez, ve --embed modda herhangi embed olmaz. --prettify Seçenek seçilirse, google en güzelleştirmek kütüphane kaynağı yerine pygments vurgulayarak için kullanılacaktır, ve hem --embed kullanılan --prettify eğer, otomatik gömülü olacaktır.
Redtape da basit tek-sayfa javascript gösteriler için uygundur, ve --use-js etkinse, redtape jquery ve Bootstrap en javascript kütüphanelerini içerir.
özelleştirme çıkışı
Çıktı Özelleştirme çeşitli şekillerde yapmak kolaydır. Olmayan gömülü belgeler için varlık CSS değiştirerek yanı sıra, aynı zamanda üstbilgi ve altbilgi eklemek veya hatta redtape varsayılan şablona dayalı özel belge şablonları kullanabilirsiniz.
Başlıklar ve sayfa altlıklarının
Eğer özelleştirilmiş belge başlığını var ya da belgeler eklenir istiyorsanız altbilgi varsa, üstbilgi ve altbilgi olarak config kullanılacak Eğer render olan temel dizin veya set varsayılan yollara başlık.html ve altlık.html belgeleri ekleyebilirsiniz ya. Varsayılan olarak, bu sırasıyla, belgenizin üst ve alt kısmında yer alacaktır.
Belgelerin bir örneği seti olabilir:
> Ls MyDocs /
MyDocs / index.md MyDocs / simple.md MyDocs / advanced.md
MyDocs / başlık.html MyDocs / altlık.html
Rt MyDocs ile Rendering MyDocs dizindeki her belge için başlık ve altbilgi kullanacaktır.
Özel şablonlar
Eğer çok özel gereksinimleri varsa, kendi belge şablonu yazma ve çıkış toplam kontrole sahip olabilir. Redtape şablonları django benzer bir yaygın olarak kullanılan çiftleşmiş sistemi jinja2 çiftleşmiş motoru kullanır. --context Argümanı ile çalıştırın redtape değişkenleri şablon mevcut ne kısa bir fikir edinmek için.
Ayrıca redtape varsayılan şablon adıdır basic.jinja, gelen devralabilir. Bu şablon temel CSS ve JavaScript redtape işlevselliğini koruyarak, örneğin, ayrı bir belge vücut süre zanaat sağlayacak iki blok, baş ve vücudu, tanımlar. Her iki geçersiz kılma standart HTML5 belge yapısı ile yalnız bırakacaktır.
Sen --template, -t ile kullanmak veya custom.html veya custom.jinja gibi belge dizine yerleştirmek için özel bir şablon belirtebilirsiniz

Gereksinimler :.

• Python