redtape

redtape is een gerichte document generator die gebruikt GitHub gearomatiseerd afwaardering tot eenvoudige, aantrekkelijke HTML-documenten te genereren. Het integreert automatisch met twitter bootstrap en beschikt over een eenvoudige, aantrekkelijke styling. redtape is geïnspireerd op d, maar pogingen om een ​​eenvoudige interface hebben, terwijl nog het toestaan ​​van gebruikers om stijl en hun output documenten te controleren om een ​​hoge mate van maatwerk.
Het installeren
Als je op linux of OSX, kunt u pip gebruiken om te installeren:
> Pip redtape installeren
Die zal redtape en zijn afhankelijkheden installeren.
Gebruik
Te gebruiken, run rt op een document of map vol documenten. Als draaien op een map, zal rt html-bestanden voor elke afwaardering bestand (.md, .mdown, of .markdown extensies) te maken:
> Rt mydocument.md
> Rt documentatie /
activa
Standaard rt ervan uitgegaan dat u het opzetten van een locatie om de bestanden waaruit de activa die koppelingen naar deze documenten rt dienen. De lay-out is precies hetzelfde als de activa directory in de redtape repository: / assets / {css, img, js} / .. voor elk actief dat u gaat gebruiken. Als u wilt redtape's standaard activa te gebruiken, kunt u eenvoudig een geschikte troef directory in de huidige directory door lopen:
> Rt --create-activa
Als u werkt in één document mode of niet wenst in te stellen een actief directory op de uiteindelijke gastheer voor uw HTML-documenten, kunt u redtape vertellen om elk actief gebruikt in een document met behulp van --embed insluiten:
> Rt --embed mydocument.md
javascript
Standaard redtape geen javascript nodig om te draaien, en zal geen insluiten in --embed modus. Als de --prettify optie is geselecteerd, zal Prettify bibliotheek google's worden gebruikt voor de bron benadrukken in plaats van pygments, en als --prettify en --embed worden beide gebruikt, zal deze automatisch worden ingebed.
Redtape is ook geschikt voor eenvoudige single-page javascript demonstraties, en als --gebruik-js is ingeschakeld, zal redtape omvatten jQuery en javascript bibliotheken bootstrap's.
aanpassen uitgang
Aanpassen output is gemakkelijk te doen op verschillende manieren. Naast het veranderen van het actief CSS voor niet-ingebedde documenten, kunt u ook de kop- en voetteksten toe te voegen of zelfs aangepaste document templates gebaseerd op standaard sjabloon redtape's gebruiken.
kop- en voetteksten
Als u een aangepaste document kop- of voettekst die u wilt toevoegen aan uw documenten, kunt u ofwel header.html en footer.html documenten toe te voegen aan de basis directory die u renderen of stel standaardpaden om gebruikt te worden in de config als kop- en voettekst. Standaard wordt deze geplaatst worden aan de boven- en onderkant van uw document, respectievelijk.
Een sample set van documenten zouden kunnen zijn:
> Ls mijndocs /
mijndocs / index.md mijndocs / simple.md mijndocs / advanced.md
mijndocs / header.html mijndocs / footer.html
Rendering mijndocs met rt mijndocs zal de kop- en voettekst te gebruiken voor elk document in de directory.
aangepaste sjablonen
Als u zeer specifieke wensen, dan kunt u uw eigen documentsjabloon te schrijven en hebben een totale controle van de output. Redtape gebruikt de jinja2 template engine, dat is een veel gebruikte template systeem vergelijkbaar met sjablonen django. Voer redtape de --context argument voor een kort idee van welke variabelen zijn beschikbaar om de matrijs te krijgen.
U kunt ook erven van basic.jinja, dat is de naam van de standaard sjabloon redtape's. Dit sjabloon definieert twee blokken, hoofd en lichaam, dat zou toestaan ​​om ambachtelijke een duidelijke document lichaam, terwijl, bijvoorbeeld, met behoud van de basis CSS en JavaScript-functionaliteit van redtape. Dwingende beiden zal u met een standaard HTML5 documentstructuur.
U kunt een aangepaste sjabloon opgeven om te gebruiken met -t, --template of plaats het in het document directory als custom.html of custom.jinja

Eisen .

• Python