redtape

redtape er et fokusert dokument generator som bruker github flavored Markdown å generere enkle, attraktive HTML-dokumenter. Den integrerer automatisk med twitter bootstrap og har en enkel, styling. redtape er inspirert av d, men forsøker å ha et enkelt grensesnitt samtidig gir brukerne å style og kontrollere sine utgangs dokumenter til en høy grad av tilpasning.
Installere
Hvis du er på Linux eller OSX, kan du bruke pip for å installere:
> Pip installere redtape
Som vil installere redtape og dens avhengigheter.
Bruk
Å bruke, kjøre rt på et dokument eller en katalog full av dokumenter. Hvis kjøre på en katalog, vil rt opprette html-filer for hvert markdown-fil (.md, .mdown eller .markdown extensions):
> Rt mydocument.md
> Rt dokumentasjon /
eiendeler
Som standard foruts rt du har satt opp et sted å tjene filene som har eiendeler som RT linker til disse dokumentene. Oppsettet er nøyaktig den samme som eiendeler katalog i redtape depotet: / eiendeler / {css, img, js} / .. for hver eiendel som du skal bruke. Hvis du ønsker å bruke redtape standard eiendeler, kan du enkelt lage en egnet ressurs katalog i gjeldende mappe ved løping:
> rt --create-eiendeler
Hvis du kjører i ett dokument modus eller ikke ønsker å sette opp en eiendel katalog på den endelige verten for HTML-dokumenter, kan du fortelle redtape å bygge inn hver eiendel i et dokument ved hjelp --embed:
> Rt --embed mydocument.md
javascript
Som standard redtape ikke krever noen javascript for å løpe, og vil ikke legge noe i --embed modus. Hvis --prettify alternativet er valgt, vil Googles prettify bibliotek brukes til kilden fremhever i stedet for pygments, og hvis --prettify og --embed er begge brukes, vil det automatisk bli integrert.
Redtape er også egnet for enkle enkeltsidige javascript demonstrasjoner, og hvis --use-js er aktivert, vil redtape inkludere jQuery og bootstrap er Javascript-biblioteker.
tilpasse produksjonen
Å tilpasse produksjonen er lett å gjøre i en rekke måter. Foruten å endre aktiva CSS for ikke-embedded dokumenter, kan du også legge til topp- og bunntekst eller bruke tilpassede dokumentmaler basert på redtape standard mal.
topp- og bunntekst
Hvis du har en tilpasset dokument header eller bunnteksten du ønsker å legge til dine dokumenter, kan du enten legge header.html og footer.html dokumenter til basen katalogen du rendering eller angi standardbaner som skal brukes i config som topp- og bunntekst. Som standard, vil disse bli plassert på toppen og bunnen av dokumentet, henholdsvis.
En prøve sett av dokumenter kan være:
> ls MyDocs /
MyDocs / index.md MyDocs / simple.md MyDocs / advanced.md
MyDocs / header.html MyDocs / footer.html
Rende MyDocs med rt MyDocs vil bruke topp- og bunntekst for hvert dokument i katalogen.
definerte maler
Hvis du har veldig spesifikke krav, kan du skrive din egen dokumentmal og har total kontroll over produksjonen. Redtape bruker jinja2 sjablonmiddel motor, som er en mye brukt sjablonmiddel system som ligner på django maler. Kjør redtape med --context argument for å få en kort idé om hva variabler er tilgjengelige for malen.
Du kan også arve fra basic.jinja, som er navnet på redtape standard mal. Denne malen definerer to blokker, hode og kropp, som vil tillate deg å lage en tydelig dokument kroppen mens for eksempel beholde den grunnleggende CSS og Javascript-funksjonalitet for redtape. Styrer både vil forlate deg med en standard HTML5 dokumentstruktur.
Du kan angi en egendefinert mal å bruke med -t, --template eller legg den i dokumentområdet som custom.html eller custom.jinja

Krav .

• Python