RedTape es un generador de documentos enfocada que utiliza github rebaja sabor para generar documentos HTML sencillos y atractivos. Se integra automáticamente con twitter bootstrap y cuenta con atractivo diseño simple,. RedTape se inspira en d, pero los intentos de tener una interfaz simple, mientras que los usuarios sin impedir a estilo y el control de sus documentos de salida a un alto grado de personalización.
Instalación
Si usted está en Linux o OSX, puede utilizar pip instalar:
> PIP instalar RedTape
Que instalará RedTape y sus dependencias.
Uso
Para utilizar, plazo rt en un documento o un directorio completo de los documentos. Si se ejecuta en un directorio, rt creará archivos html para cada archivo de rebajas (.MD, .mdown o extensiones .markdown):
> Rt mydocument.md
> Documentación rt /
activos
Por defecto, rt asume que ha configurado una ubicación para servir a los archivos de la que tienen los activos que la RT enlaces en estos documentos. El diseño es exactamente el mismo que el directorio de activos en el repositorio RedTape: / assets / {css, img, js} / .. para cada activo que va a utilizar. Si desea utilizar los activos por defecto de RedTape, usted puede crear fácilmente un directorio activo adecuado en el directorio actual de funcionamiento:
> rt --create-activos
Si está ejecutando en modo de documento único o no desea configurar un directorio activo en la eventual acogida de los documentos HTML, se puede decir RedTape incrustar cada activo utilizado en un documento mediante --embed:
> Rt --embed mydocument.md
javascript
Por defecto, RedTape no requiere ningún javascript para funcionar, y no incorporar ninguna en modo --embed. Si se selecciona la opción --prettify, biblioteca prettify de google se utilizará para la fuente destacando en lugar de Pygments, y si --prettify y son utilizados --embed, se incorpora automáticamente.
RedTape también es adecuado para una sola página manifestaciones javascript simples, y si --use-js está habilitada, RedTape incluirá jQuery y bibliotecas JavaScript de arranque.
salida personalización
Personalización de salida es fácil de hacer en una variedad de maneras. Además de cambiar la CSS activo para los documentos no incrustadas, también puede agregar encabezados y pies de página o incluso utilizar plantillas de documentos personalizados basados en la plantilla por defecto de RedTape.
encabezados y pies de página
Si usted tiene un encabezado de documento personalizadas o pie de página que desea añadir a sus documentos, puede añadir documentos header.html y footer.html al directorio base se renderiza o rutas predeterminadas establecidas para ser utilizado en la configuración como encabezado y pie de página. Por defecto, estos se colocan en la parte superior e inferior de su documento, respectivamente.
Un conjunto de muestras de documentos podría ser:
> ls misdocs /
misdocs / index.md misdocs / simple.md misdocs / advanced.md
misdocs / header.html misdocs / footer.html
Rendering misdocs con misdocs rt utilizarán el encabezado y el pie de cada documento en el directorio.
plantillas personalizadas
Si usted tiene requisitos muy específicos, usted puede escribir su propia plantilla de documento y tener un control total de la salida. RedTape utiliza el motor de plantillas Jinja2, que es un sistema de plantillas utilizado ampliamente similar a django plantillas. RedTape Ejecutar con el argumento --context para obtener una rápida idea de qué variables están disponibles para la plantilla.
También puede heredar de basic.jinja, que es el nombre de la plantilla por defecto de RedTape. Esta plantilla define dos bloques, la cabeza y el cuerpo, lo que permitiría a las embarcaciones de un documento distinto del cuerpo, mientras que, por ejemplo, conservando el CSS básico y la funcionalidad de JavaScript del RedTape. Anulación tanto te dejará con una estructura de documento estándar HTML5.
Puede especificar una plantilla personalizada para su uso con -t, --template o colocarlo en el directorio de documentos como custom.html o custom.jinja
Requisitos :.
- Python
Comentarios que no se encuentran