redtape

redtape egy koncentrált dokumentum generátor, amely GitHub ízesített árleszállítás generálni egyszerű, vonzó HTML dokumentumokat. Automatikusan integrálja a twitter bootstrap és funkciók egyszerű, vonzó stílus. redtape ihlette d, hanem megpróbálja, hogy egy egyszerű felületen, ugyanakkor lehetővé teszi a felhasználóknak, hogy a stílus és ellenőrizni tudják kimeneti dokumentumok nagyfokú testreszabhatóság.
telepítése
Ha Linux vagy OSX, akkor pip telepíteni:
> Pip telepíteni redtape
Melyik telepíti redtape és a függőségeit.
Használat
Használni, run rt egy dokumentumot vagy könyvtár teljes dokumentumot. Ha fut egy könyvtár, rt teremt html fájlokat minden árleszállítás fájl (.md, .mdown, vagy .markdown kiterjesztések):
> Rt mydocument.md
> Rt dokumentáció /
eszközök
Alapértelmezésben rt feltételezi, hogy hozzanak létre egy helyre szolgálni a fájlokat, amelyek a vagyon rt linkeket ezeket a dokumentumokat. Az elrendezés pontosan ugyanaz, mint az eszközök könyvtár a redtape repository: / eszközök / {css, img, js} / .. minden eszközt, hogy használni fog. Ha a használni kívánt redtape alapértelmezett eszközök, könnyen létrehozhat egy megfelelő eszköz könyvtár az aktuális könyvtárban így:
> Rt --create-eszközök
Ha fut az egyetlen dokumentum módban, vagy nem kívánja létrehozni egy eszköz könyvtár az esetleges fogadó HTML dokumentumokhoz, meg tudod mondani redtape beágyazni minden eszközre, amely dokumentumot a --embed:
> Rt --embed mydocument.md
javascript
Alapértelmezésben redtape nem igényel semmilyen javascript futtatását, és nem beágyazni minden a --embed módban. Ha a --prettify opciót választja, a Google prettify könyvtár fogják használni forrása kiemelve helyett pygments, és ha --prettify és --embed is használja, akkor automatikusan ágyazva.
Redtape is alkalmas egyszerű egyoldalas javascript tüntetések, és ha --use-js engedélyezve van, redtape tartalmazza jQuery és bootstrap JavaScript könyvtárak.
testre output
Testreszabása kimeneti könnyű megtenni a legkülönfélébb módokon. Különben is változik az eszköz CSS Nem beágyazott dokumentumokat, akkor is hozzá fejlécek és a lábjegyzetek, vagy akár használja az egyéni dokumentumsablonok alapján redtape alapértelmezett sablont.
fejlécek és a lábjegyzetek
Ha van egy egyedi dokumentum fejléc vagy lábléc hozzá kíván adni a dokumentumokat, akkor vagy hozzá header.html és footer.html dokumentumok a bázis könyvtárban van téve, vagy alapértelmezett útvonalakat kell használni a config mint fejléc és a lábléc. Alapértelmezésben ezek kerülnek a tetején és alján a dokumentum, ill.
A mintát sor dokumentumot lehet:
> Ls mydocs /
mydocs / index.md mydocs / simple.md mydocs / advanced.md
mydocs / header.html mydocs / footer.html
Rendering mydocs RT mydocs fogja használni a fejléc és a lábléc az egyes dokumentumok a könyvtárban.
Egyedi sablonokat
Ha nagyon konkrét követelményeket írhat saját dokumentum sablont, és a teljes irányítást a kimenetet. Redtape használja jinja2 sablonozás motor, amely a széles körben használt sablonrendszer hasonló django sablonok. Fuss redtape a --context érv, hogy egy rövid gondolat, hogy milyen változók állnak a sablont.
Azt is örökölnek basic.jinja, amely a nevét a redtape alapértelmezett sablont. Ez a sablon határozza meg a két tömb, fej és a test, amely lehetővé tenné, hogy kézműves külön dokumentumban test, míg például, megtartva az alapvető CSS és JavaScript funkcionalitását redtape. Elsőbbség mind a magad szabványos HTML5 dokumentum szerkezetét.
Akkor meg egy egyéni sablont az -t, --template vagy helyezze a dokumentumot a könyvtárban, custom.html vagy custom.jinja.

követelmények :

• Python