commit f5609ae8922205af512d243abb235ea5176a6ca4 parent 273bbdf924c7d011c6249334e94a34a04a18fe39 Author: Torsten Grote <t@grobox.de> Date: Thu, 30 Apr 2020 14:50:13 -0300 Add markdown conventions to design document 003 Diffstat:
| M | design-documents/003-tos-rendering.rst | | | 21 | +++++++++++++++++++++ |
1 file changed, 21 insertions(+), 0 deletions(-)
diff --git a/design-documents/003-tos-rendering.rst b/design-documents/003-tos-rendering.rst @@ -42,6 +42,27 @@ document" for generating the corresponding legal agreement document in other formats. However, service providers can also provide custom versions with more appropriate styling, like a logo in the header of a printable PDF document. +Markdown Conventions +-------------------- + +The ``text/markdown`` document **should** follow +the `commonmark spec <https://spec.commonmark.org/0.28/>`__. +Main headlines (level 1) and their following content (until the next main headline) +will be shown as expandable sections in wallets. + +The document **must** begin with a main headline: + +.. code-block:: + + # First Headline + +or + +.. code-block:: + + First Headline + ============== + Alternatives ============