Redtape è un generatore di documenti mirata che utilizza GitHub Markdown aromatizzato per generare, documenti interessanti HTML semplici. Si integra automaticamente con Twitter bootstrap e funzionalità semplici, dallo stile affascinante. Redtape si ispira d, ma i tentativi di avere una semplice interfaccia mentre gli utenti ancora consentendo di stile e controllare i loro documenti di output di un elevato grado di personalizzazione.
Installazione
Se siete su Linux o OSX, è possibile utilizzare pip da installare:
> Pip installare Redtape
Che installerà Redtape e le sue dipendenze.
Utilizzo
Per utilizzare, corsa rt su un documento o una directory piena di documenti. Se eseguito su una directory, rt creerà i file HTML per ogni file Markdown (.MD, .mdown, o estensioni .markdown):
> Rt mydocument.md
> Documentazione rt /
attività
Per impostazione predefinita, rt presuppone aver impostato un percorso per servire i file da cui sono le attività che RT link in questi documenti. Il layout è esattamente la stessa della directory asset presenti nel repository Redtape: / attività / {css, img, js} / .. per ciascuna risorsa che si intende utilizzare. Se volete utilizzare i beni di default di Redtape, è possibile creare facilmente una cartella risorsa adeguata nella directory corrente eseguendo:
> rt --create-assets
Se si esegue in modalità documento unico o non si desidera impostare un elenco di asset sull'eventuale host per i vostri documenti HTML, si può dire Redtape per incorporare ogni risorsa utilizzata in un documento utilizzando --embed:
> Rt --embed mydocument.md
javascript
Per impostazione predefinita, Redtape non richiede alcuna JavaScript per funzionare, e non incorporare qualsiasi in modalità --embed. Se si seleziona l'opzione --prettify, biblioteca Prettify di Google verrà utilizzato per la fonte di evidenziare invece di pygments, e se --prettify e --embed sono entrambi utilizzati, verrà incorporato automaticamente.
Redtape è adatto anche per semplici sola pagina dimostrazioni javascript, e se --use-js è abilitata, Redtape includerà jquery e librerie javascript di bootstrap.
uscita personalizzazione
Personalizzazione uscita è facile da fare in una varietà di modi. Oltre a cambiare il CSS bene per documenti non incorporato, è possibile anche aggiungere intestazioni e piè di pagina o anche utilizzare i modelli di documento personalizzati basati su modello di default di Redtape.
intestazioni e piè di pagina
Se si dispone di una intestazione del documento personalizzato o piè di pagina che si desidera aggiunto ai documenti, è possibile aggiungere documenti header.html e footer.html alla directory base rendete o percorsi predefiniti impostati per essere utilizzato nella configurazione come intestazione e piè di pagina. Per impostazione predefinita, questi saranno posizionati nella parte superiore e inferiore del documento, rispettivamente.
Una serie campione di documenti potrebbe essere:
> ls mydocs /
mydocs / index.md mydocs / simple.md mydocs / advanced.md
mydocs / header.html mydocs / footer.html
Mydocs rendering con mydocs RT utilizzeranno l'intestazione e piè di pagina per ogni documento nella directory.
modelli personalizzati
Se si dispone di requisiti molto specifici, è possibile scrivere il proprio modello di documento e di avere il controllo totale della produzione. Redtape utilizza il motore di template Jinja2, che è un sistema di template ampiamente usata, analoga a Django modelli. Redtape Eseguire con l'argomento --context per avere una breve idea di quali variabili sono disponibili per il modello.
È inoltre possibile ereditare da basic.jinja, che è il nome del modello di default di Redtape. Questo modello definisce due blocchi, la testa e il corpo, che consentono di realizzare una distinta mentre il corpo del documento, per esempio, mantenendo il CSS di base e le funzionalità JavaScript di Redtape. Sostituzione entrambi vi lascerà con una struttura del documento HTML5 standard.
È possibile specificare un modello personalizzato da utilizzare con -t, --template o inserirlo nella directory documento come custom.html o custom.jinja
Requisiti :.
- Python
I commenti non trovato