mirror of
https://github.com/matrix-org/matrix-spec
synced 2026-01-03 22:43:43 +01:00
22 lines
585 B
Markdown
22 lines
585 B
Markdown
|
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``.
|