redtape

redtape er en fokuseret dokument generator, der bruger GitHub flavored markdown at generere simple, attraktive HTML-dokumenter. Den automatisk integreres med twitter bootstrap og funktioner enkel, attraktiv styling. redtape er inspireret af d, men forsøg på at have en enkel grænseflade, mens du stadig giver brugerne mulighed for at style og kontrollere deres output dokumenter til en høj grad af tilpasning.
Installation
Hvis du er på Linux eller OSX, kan du bruge pip at installere:
> Pip installere redtape
Hvilket vil installere redtape og dens afhængigheder.
Anvendelse
Hvis du vil bruge, køre rt på et dokument eller en mappe fuld af dokumenter. Hvis kørt på en mappe, vil rt skabe html-filer til alle markdown fil (.md, .mdown eller .markdown udvidelser):
> Rt mydocument.md
> Rt dokumentation /
aktiver
Som standard antager rt du har oprettet et sted at tjene filer fra, som har de aktiver, RT links i disse dokumenter. Layoutet er nøjagtig den samme som den aktiver mappe i redtape repository: / aktiver / {css, IMG, js} / .. for hvert aktiv, som du vil bruge. Hvis du ønsker at bruge redtape standardindstillinger aktiver, kan du nemt oprette en passende aktiv mappe i det aktuelle bibliotek ved at køre:
> rt --create-aktiver
Hvis du kører i enkelt dokument mode eller ikke ønsker at etablere et aktiv mappe på den endelige vært for dine HTML-dokumenter, kan du fortælle redtape at indlejre hvert aktiv, der anvendes i et dokument ved hjælp --embed:
> Rt --embed mydocument.md
JavaScript
Som standard redtape ikke kræver nogen javascript til at køre, og det vil ikke integrere nogen i --embed mode. Hvis der er valgt den --prettify mulighed, vil Googles forskønne bibliotek bruges til kilde fremhæve stedet for pygments, og hvis --prettify og --embed begge anvendes, vil den automatisk blive indlejret.
Redtape er også velegnet til simple enkeltsidede javascript demonstrationer, og hvis --use-js er aktiveret, vil redtape omfatte jquery og bootstrap s javascript biblioteker.
tilpasse output
Tilpasning output er let at gøre på en række måder. Udover at ændre aktivet CSS for ikke-integrerede dokumenter, kan du også tilføje sidehoveder og sidefødder eller endda bruge brugerdefinerede dokumentskabeloner baseret på redtape standardskabelon.
sidehoveder og sidefødder
Hvis du har en tilpasset dokument sidehoved eller en sidefod, du vil føjet til dine dokumenter, kan du enten tilføje header.html og footer.html dokumenter basismappen du rendering eller sat standardstier der skal anvendes i den config som sidehoved og sidefod. Som standard, vil disse blive placeret i toppen og bunden af ​​dokumentet, hhv.
En prøve sæt dokumenter kunne være:
> ls MyDocs /
MyDocs / index.md MyDocs / simple.md MyDocs / advanced.md
MyDocs / header.html MyDocs / footer.html
Rendering MyDocs med strålebehandling MyDocs vil bruge sidehoved og sidefod for hvert dokument i mappen.
brugerdefinerede skabeloner
Hvis du har meget specifikke krav, kan du skrive dit eget dokument skabelon og har total kontrol af produktionen. Redtape bruger jinja2 templating motor, som er et meget anvendt templating system svarende til Django skabeloner. Kør redtape med --context argument for at få en kort idé om, hvad variabler er tilgængelige for skabelonen.
Du kan også arve fra basic.jinja, som er navnet på redtape standardskabelon. Denne skabelon definerer to blokke, hoved og krop, som vil tillade dig at udforme en særskilt dokument krop, mens for eksempel fastholde den grundlæggende CSS og JavaScript-funktionalitet på redtape. Overstyring både vil efterlade dig med en standard HTML5 dokument struktur.
Du kan angive en brugerdefineret skabelon til brug med -t, --template eller placere den i dokumentområdet som custom.html eller custom.jinja

Krav :.

• Python