summaryrefslogtreecommitdiff
path: root/design-documents
diff options
context:
space:
mode:
authorTorsten Grote <t@grobox.de>2020-04-30 14:50:13 -0300
committerTorsten Grote <t@grobox.de>2020-04-30 14:50:13 -0300
commitf5609ae8922205af512d243abb235ea5176a6ca4 (patch)
tree68769af635e39d88c0b68f45ae8d66dbb38ef8a7 /design-documents
parent273bbdf924c7d011c6249334e94a34a04a18fe39 (diff)
downloaddocs-f5609ae8922205af512d243abb235ea5176a6ca4.tar.gz
docs-f5609ae8922205af512d243abb235ea5176a6ca4.tar.bz2
docs-f5609ae8922205af512d243abb235ea5176a6ca4.zip
Add markdown conventions to design document 003
Diffstat (limited to 'design-documents')
-rw-r--r--design-documents/003-tos-rendering.rst21
1 files changed, 21 insertions, 0 deletions
diff --git a/design-documents/003-tos-rendering.rst b/design-documents/003-tos-rendering.rst
index 5f6d815..52d293c 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 <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
============