You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: 15/umbraco-cms/reference/umbraco-flavored-markdown.md
+12-10Lines changed: 12 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,24 +12,25 @@ UFM is built on top of [GitHub Flavored Markdown](https://github.github.com/gfm/
12
12
13
13
## Syntax
14
14
15
-
The essence of the UFM syntax is curly brackets with a marker prefix.
15
+
The essence of the UFM syntax is curly brackets with an alias prefix delimited with a colon.
16
16
17
17
```markdown
18
-
{<marker prefix> <contents>}
18
+
{<alias prefix>: <contents>}
19
19
```
20
20
21
21
For clarity...
22
22
23
-
- The opening is `{` U+007B Left Curly Bracket
24
-
- The closing is `}` U+007D Right Curly Bracket
25
-
-The marker prefix can be any valid Unicode character(s), including emojis
23
+
- The opening token is `{` U+007B Left Curly Bracket
24
+
- The alias prefix can be any valid Unicode character(s), including emojis
25
+
-Followed by `:` U+003A Colon, (not part of the alias prefix itself)
26
26
- The contents within the curly brackets can include any Unicode characters, including whitespace
27
+
- The closing token is `}` U+007D Right Curly Bracket
27
28
28
-
An example of this syntax to render a value of a property by its alias is: `{= bodyText}`.
29
+
An example of this syntax to render a value of a property by its alias is: `{umbValue: bodyText}`.
29
30
30
-
The curly brackets indicate that the UFM syntax should be processed. The `=` marker prefix indicates which UFM component should be rendered, and the `bodyText` contents are the parameter that is passed to that UFM component.
31
+
The curly brackets indicate that the UFM syntax should be processed. The `umbValue` alias prefix indicates which UFM component should be rendered, and the `bodyText` contents are the parameter that is passed to that UFM component.
31
32
32
-
With this example, the syntax `{= bodyText}` would be processed and rendered as the following markup:
33
+
With this example, the syntax `{umbValue: bodyText}` would be processed and rendered as the following markup:
@@ -75,7 +76,8 @@ export class MyCustomUfmComponentApi implements UmbUfmComponentBase {
75
76
export { MyCustomUfmComponentApiasapi };
76
77
```
77
78
78
-
Using the syntax `{% myCustomText }` would render the markup `<ufm-custom-component text="myCustomText">`. Then inside the `ufm-custom-component` component code, you can perform any logic to render your required markup.
79
+
Using the syntax `{myCustom: myCustomText}` would render the markup `<ufm-custom-component text="myCustomText">`. Then inside the `ufm-custom-component` component code, you can perform any logic to render your required markup.
0 commit comments