Skip to content

Commit afdeb0d

Browse files
committed
docs: Updat Readme
1 parent a6c5ab9 commit afdeb0d

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

README.md

+5-3
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,8 @@ Within a `rant` block (both inline and code blocks), the result of the program i
3535
That means that you can add styling, links, or other markdown-processing elements inside a `rant` block, and they will be rendered accordingly.
3636
In order to avoid Rant syntax errors, you can wrap these elements in double quotes, because Rant treats everything inside double quotes as [string literals](https://docs.rant-lang.org/language/text.html#string-literals), and will not evaluate the content.
3737

38+
For common markdown operations, the following global functions are added to the Rant context: `bold`, `italic`, `bold-italic`, `highlight`, `link`
39+
3840
You can also embed the result of an existing rant codeblock into any other document or other rant block by using [block links](https://help.obsidian.md/How+to/Link+to+blocks), see [these examples](#embedding-rant-blocks) for details.
3941

4042
## Examples
@@ -70,11 +72,11 @@ Result:
7072

7173
### Styling
7274

73-
This is an example of how to apply markdown styling within the Rant code block, note the usage of double quotes:
75+
This is an example of how to apply markdown styling using the global markdown functions:
7476

7577
````markdown
7678
```rant
77-
"**"{Hello|Hi|Hey}"**" world!
79+
[bold: {Hello|Hi|Hey}] world!
7880
```
7981
````
8082
Result:
@@ -87,7 +89,7 @@ You can use any form of links within a Rant code block, and it properly renders
8789

8890
````markdown
8991
```rant
90-
[rep:10][sep:"-"]{"[[A Page]]"|"[External link](https://www.wikipedia.org)"|Just text}
92+
[rep:10][sep:"-"]{[link: A Page]|"[External link](https://www.wikipedia.org)"|Just text}
9193
```
9294
````
9395
Result:

0 commit comments

Comments
 (0)