From f5609ae8922205af512d243abb235ea5176a6ca4 Mon Sep 17 00:00:00 2001 From: Torsten Grote Date: Thu, 30 Apr 2020 14:50:13 -0300 Subject: Add markdown conventions to design document 003 --- design-documents/003-tos-rendering.rst | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/design-documents/003-tos-rendering.rst b/design-documents/003-tos-rendering.rst index 5f6d8157..52d293c3 100644 --- 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 `__. +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 ============ -- cgit v1.2.3