From 56055b2d7dadde2584e54bf36af89aaa1d977b9a Mon Sep 17 00:00:00 2001 From: SebastianMC Date: Fri, 7 Oct 2022 11:22:04 +0200 Subject: [PATCH] Documentation update - syntax reference playing with the format --- docs/svg/syntax-1.svg | 114 +++++++++++++++++++++++++++++++++++++++ docs/syntax-reference.md | 2 + 2 files changed, 116 insertions(+) create mode 100644 docs/svg/syntax-1.svg diff --git a/docs/svg/syntax-1.svg b/docs/svg/syntax-1.svg new file mode 100644 index 0000000..c56b888 --- /dev/null +++ b/docs/svg/syntax-1.svg @@ -0,0 +1,114 @@ + + + + + Produced by OmniGraffle 7.20\n2022-10-07 09:19:46 +0000 + + syntax-1 + + Layer 1 + + + + + Some note + + + + + + + + --- + + + + + sorting-spec: | + + + + + .......... + + + + + .......... + + + + + .......... + + + + + .......... + + + + + .......... + + + + + .......... + + + + + .......... + + + + + .......... + + + + + section + + + + + + + + + + + section + + + + + + + + + + + --- + + + + + ... some other YAML content + + + + + Note text + + + + + ... + + + + + diff --git a/docs/syntax-reference.md b/docs/syntax-reference.md index 2d59197..990077d 100644 --- a/docs/syntax-reference.md +++ b/docs/syntax-reference.md @@ -13,6 +13,8 @@ The intention is to make it understandable to non-technical persons. # The syntax +![Visual idea of the syntax](./svg/syntax-1.svg) + ## Sorting specification - the `sorting specification` has textual format