redtape 1.2

javascript

By default, redtape not require any javascript to run, and will not embed any in --embed mode. If the --prettify option is selected, google’s prettify library will be used for source highlighting instead of pygments, and if --prettify and --embed are both used, it will be automatically embedded.

Redtape is also suitable for simple single-page javascript demonstrations, and if --use-js is enabled, redtape will include jquery and bootstrap’s javascript libraries.

headers and footers

If you have a customized document header or footer you want added to your documents, you can either add header.html and footer.html documents to the base directory you are rendering or set default paths to be used in the config as header and footer. By default, these will be placed at the top and bottom of your document, respectively.

A sample set of documents could be:

> ls mydocs/
mydocs/index.md       mydocs/simple.md      mydocs/advanced.md
mydocs/header.html    mydocs/footer.html

Rendering mydocs with rt mydocs will use the header and footer for each document in the directory.

custom templates

If you have very specific requirements, you can write your own document template and have total control of the output. Redtape uses the jinja2 templating engine, which is a widely used templating system similar to django templates. Run redtape with the --context argument to get a brief idea of what variables are available to the template.

You can also inherit from basic.jinja, which is the name of redtape’s default template. This template defines two blocks, head and body, which would allow you to craft a distinct document body while, for instance, retaining the basic CSS and JavaScript functionality of redtape. Overriding both will leave you with a standard HTML5 document structure.

You can specify a custom template to use with -t, --template or place it in the document directory as custom.html or custom.jinja.