From fd3633a1f51b6c4ef7dbe83f31856ddf0ff33420 Mon Sep 17 00:00:00 2001 From: robbyriverside Date: Sun, 30 Jan 2022 18:34:48 -0800 Subject: [PATCH] add delimiters (#2) Co-authored-by: Rob Farrow --- README.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/README.md b/README.md index 9fce6cf..9c914f0 100644 --- a/README.md +++ b/README.md @@ -278,12 +278,21 @@ The purpose of this shorthand is to improve readability and standardize on eleme Line cannot start with a back-tic. Body text requires an element. Content back-tic is last feature on a line. A line that starts with plus '+' is a continuation of the attributes on the line above. May be followed by a space. +Using simple back string (or rawstring): ```brief elem:foo bar:zed + more:true range:"3 to 5" ` more content here` ``` +Or using special hash delimiter (#| |#, #@ @#, #$ $#, #% %#) for when you need a nested rawstring `` +```brief +elem:foo bar:zed + + more:true range:"3 to 5" #| + more content here + |# +``` + ### Include files To keep files modular the #include directive allows other brief files to be inserted. The decoder handles indentation for you so each file can be indented naturally from zero. Include directives insert files so they can be treated like any other sub-element.