redtape

Redtape est un générateur de documents ciblée qui utilise github démarque aromatisé pour générer des documents HTML simples, attrayantes. Il intègre automatiquement avec twitter bootstrap et dispose d'un style simple et attrayant. Redtape est inspiré par d, mais les tentatives d'avoir une interface simple tout en permettant aux utilisateurs de style et de contrôler leurs documents de sortie à un haut degré de personnalisation.
Installation
Si vous êtes sous Linux ou OSX, vous pouvez utiliser pip à installer:
> Pip installer Redtape
Qui va installer Redtape et ses dépendances.
Utilisation
Pour l'utiliser, rt terme sur un document ou un répertoire complet de documents. Se il est exécuté sur un répertoire, rt va créer des fichiers HTML pour chaque fichier de démarque (.md, .mdown ou extensions .markdown):
> Rt mydocument.md
> Documentation rt /
actifs
Par défaut, rt suppose que vous avez mis en place un lieu de servir les fichiers qui ont les actifs que la RT liens dans ces documents. La disposition est exactement le même que le répertoire des actifs dans le référentiel de Redtape: / assets / {css, img, js} / .. pour chaque actif que vous allez utiliser. Si vous souhaitez utiliser les actifs de défaut de Redtape, vous pouvez facilement créer un répertoire d'actifs appropriée dans le répertoire courant en exécutant:
> RT --create-actifs
Si vous exécutez en mode de document unique ou ne souhaitez pas mettre en place un annuaire actif sur l'hôte éventuel pour vos documents HTML, vous pouvez dire Redtape d'intégrer chaque actif utilisé dans un document en utilisant --embed:
> Rt --embed mydocument.md
javascript
Par défaut, Redtape pas exigé de javascript afin de fonctionner, et ne sera pas intégrer tout en mode --embed. Si l'option est sélectionnée --prettify, bibliothèque Prettify de Google sera utilisée pour la source en soulignant la place de pygments, et si --prettify et --embed sont tous deux utilisés, il sera intégré automatiquement.
Redtape est également adapté pour une seule page démonstrations javascript simples, et si --use-js est activée, Redtape comprendra jquery et bibliothèques javascript de bootstrap.
Sortie personnalisation
Personnalisation de sortie est facile à faire dans une variété de façons. En plus de changer la CSS de l'actif pour les documents non-intégré, vous pouvez également ajouter des en-têtes et pieds de page ou même utiliser des modèles de documents personnalisés basés sur le modèle par défaut de tracasseries.
en-têtes et pieds de page
Si vous avez un en-tête de document personnalisé ou pied de page que vous souhaitez ajouter à vos documents, vous pouvez soit ajouter header.html et footer.html documents dans le répertoire de base vous rendez ou des chemins par défaut définies pour être utilisé dans la configuration comme en-tête et pied de page. Par défaut, ceux-ci seront placés en haut et en bas de votre document, respectivement.
Un ensemble de documents de l'échantillon pourrait être:
> ls mydocs /
mydocs / index.md mydocs / simple.md mydocs / advanced.md
mydocs / header.html mydocs / footer.html
Rendu mydocs avec mydocs RT utiliser l'en-tête et pied de page pour chaque document dans le répertoire.
modèles personnalisés
Si vous avez des exigences très spécifiques, vous pouvez écrire votre propre modèle de document et avoir le contrôle total de la sortie. Redtape utilise le moteur de templates de jinja2, qui est un système largement utilisé de modèle similaire à django modèles. Redtape exécuté avec l'argument --context pour obtenir une brève idée de ce que les variables sont disponibles pour le modèle.
Vous pouvez également hériter de basic.jinja, qui est le nom du modèle par défaut de tracasseries. Ce modèle définit deux blocs, la tête et le corps, ce qui permettrait que vous fabriquiez une distincte tandis que le document du corps, par exemple, en conservant le CSS base et la fonctionnalité JavaScript de tracasseries. Redéfinition de fois vous laisse avec une structure de document HTML5 standard.
Vous pouvez spécifier un template personnalisé à utiliser avec -t, --template ou le placer dans le répertoire de document custom.html ou custom.jinja

Exigences :.

• Python