Skip to content

Commit

Permalink
add delimiters (#2)
Browse files Browse the repository at this point in the history
Co-authored-by: Rob Farrow <rob@fibberist.com>
  • Loading branch information
robbyriverside and Rob Farrow authored Jan 31, 2022
1 parent e928379 commit fd3633a
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit fd3633a

Please sign in to comment.