matrix
/
matrix-doc
mirror of https://github.com/matrix-org/matrix-doc.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
matrix-doc/templating
History
Kegan Dougal 75e7d09fc8 Remove newlines from json: move line wrapping to the template files. 2015-05-20 12:41:25 +01:00
..
internal Produce valid JSON (escape \n), add indent filter 2015-05-20 11:49:10 +01:00
templates Remove newlines from json: move line wrapping to the template files. 2015-05-20 12:41:25 +01:00
README.md Add templating folder and stub files/templates. 2015-05-19 11:22:33 +01:00
build.py Remove newlines from json: move line wrapping to the template files. 2015-05-20 12:41:25 +01:00

README.md

This folder contains the templates and templating system for creating the spec. We use the templating system Jinja2 in Python. This was chosen over other systems such as Handlebars.js and Templetor because we already have a Python dependency on the spec build system, and Jinja provides a rich set of template operations beyond basic control flow.

Installation

 $ pip install Jinja2

Running

To build the spec:

 $ python build.py

This will output spec.rst which can then be fed into the RST->HTML converter located in matrix-doc/scripts.