blob: ba1c4eb0afddaf32ed042ebb09ee28975187d0ee [file] [log] [blame]
======================
Documentation Overview
======================
Welcome in the Jinja documentation.
- `Installing Jinja <installation.txt>`_
- **Application Developer Documentation**:
- `Quickstart <devintro.txt>`_ - getting started with Jinja
- `Template Loaders <loaders.txt>`_ - documentation for the different
loader types and how to write custom ones.
- `Filter Functions <filters.txt>`_ - information about how to write
custom filter functions.
- `Test Functions <tests.txt>`_ - information about how to write
custom test functions.
- `Global Objects <objects.txt>`_ - information about the special global
namespace in Jinja templates.
- `Streaming Interface <streaming.txt>`_ - using Jinja for big templates
by streaming the output.
- `Internationalization <i18n.txt>`_ - how to internationalize applications
using Jinja templates.
- `Alternative Syntax <altsyntax.txt>`_ - changing the default Jinja
block / variable / comment delimiters.
- `API Documentation <api.txt>`_ - API documentation for public Jinja
objects like `Environment`.
- `Translators <translators.txt>`_ - explanation about the Jinja template
translation interface.
- `Framework Integration <frameworks.txt>`_ - integrating Jinja into
python frameworks.
- `Debugging Support <debugging.txt>`_ - debugging Jinja templates.
- `Developer Recipies <devrecipies.txt>`_ - tips and tricks for application
developers.
- **Template Designer Documentation**:
- `Syntax Reference <designerdoc.txt>`_ - quick overview over the Jinja
syntax elements.
- `Template Inheritance <inheritance.txt>`_ - template inheritance howto.
- `Filters, Tests and Helper Functions <builtins.txt>`_ - list of filters
and test/helper functions.
- `Whitespace and Escaping <escaping.txt>`_ - how to escape markup and
control whitespace.
- `Scopes and Variable Behavior <scopes.txt>`_ - behavior of undefined
variables and scoping rules.
- `Template Internationalization <templatei18n.txt>`_ - how to internationalize
Jinja templates.
- `Differences To Django <fromdjango.txt>`_ - coming from django? Then this
document is for you.
- `Designer Recipies <recipies.txt>`_ - various tips and tricks for designers.
- `Changelog <changelog.txt>`_
There is also support via IRC on the ``#pocoo`` channel on `irc.freenode.net`.