redtape

redtape je zaměřen generátor dokument, který používá ochucené Markdown GitHub generovat jednoduché, atraktivní dokumenty ve formátu HTML. To se automaticky integruje s twitter bootstrap a má jednoduchý, atraktivní design. redtape je inspirován d, ale snaží se mít jednoduché rozhraní a zároveň umožňuje uživatelům styl a řídí své výstupní dokumenty k vysokému stupni přizpůsobení.
Instalace
Pokud jste na Linux nebo OSX, můžete použít PIP k instalaci:
> Pip nainstalovat redtape
Který instalovat redtape a její závislosti.
Použít
Chcete-li použít, běh RT na dokumentu nebo adresář plný dokumentů. Pokud běží na adresář, bude rt vytvoří HTML soubory pro všechny srážky souborů (.md, .mdown, nebo .markdown rozšíření):
> Rt mydocument.md
> Dokumentace rt /
aktiva
Ve výchozím nastavení, rt předpokládá, že jste nastavit umístění sloužit soubory ze které mají aktiva, která pokojovou teplotu spojení do těchto dokumentů. Dispozice je přesně stejný jako adresář aktiva v redtape úložišti: / aktiva / {css, img, js} / .. pro každé aktivum, které budete používat. Chcete-li použít výchozí majetek redtape, můžete snadno vytvořit vhodný adresář majetku v aktuálním adresáři příkazem:
> RT --create-majetek
Pokud jsou spuštěny v režimu jednoho dokumentu nebo nechcete nastavit adresář aktiv o případném hostitele pro své dokumenty HTML, můžete říct redtape vložit každý majetek použit v dokumentu pomocí --embed:
> Rt --embed mydocument.md
javascript
Ve výchozím nastavení, redtape nevyžadují ke svému provozu JavaScript, a nebude vložit jakýkoliv v --embed režimu. Pokud je vybrána --prettify volba, bude prettify knihovna Google je použít pro zdroj zvýraznění místo pygments, a pokud --prettify --embed jsou oba používají, a to bude automaticky vložen.
Redtape je také vhodný pro jednoduché jednostránkové javascript demonstrace, a pokud je povoleno --use-js, bude redtape zahrnovat jQuery a JavaScript knihovny Bootstrap je.
přizpůsobení výkon
Přizpůsobení výkonu je snadné provést různými způsoby. Kromě změny CSS aktiv pro non-embedded dokumentů, můžete také přidat záhlaví a zápatí, nebo dokonce použít vlastní šablony dokumentu na základě výchozí šabloně redtape je.
záhlaví a zápatí
Pokud máte vlastní záhlaví nebo zápatí dokumentu chcete přidán do vašich dokumentů, můžete buď přidat header.html a footer.html dokumenty k základnímu adresáři se renderování nebo nastavit výchozí cesty mají být použity v config jako záhlaví a zápatí. Ve výchozím nastavení, budou umístěny v horní a dolní části dokumentu, resp.
Vzorek soubor dokumentů by mohlo být:
> ls mydocs /
mydocs / index.md mydocs / simple.md mydocs / advanced.md
mydocs / header.html mydocs / footer.html
Tónovaná mydocs s RT mydocs bude používat záhlaví a zápatí pro každý dokument v adresáři.
vlastní šablony
Pokud máte velmi specifické požadavky, můžete napsat svůj vlastní šablonu dokumentu a mít úplnou kontrolu nad výstupem. Redtape používá jinja2 templátové motor, který je široce používán šablonovací systém podobný Django šablon. Běh redtape s --context argumentem, aby si nástinem toho, co proměnné jsou k dispozici šablony.
Můžete také zdědit z basic.jinja, což je název výchozí šablony redtape je. Tato šablona definuje dva bloky, hlavy a těla, které by vám umožní sestavit zřetelný dokument těla, zatímco například zachování základní CSS a JavaScript funkčnost redtape. Potlačení oba opustí vás standardní strukturu dokumentu HTML5.
Můžete zadat vlastní šablony pro použití s ​​-t, --template nebo jej v adresáři dokumentů, jako custom.html nebo custom.jinja

Požadavky na :.

• Python