Skip to content

Commit a53ba1d

Browse files
committed
chore: readme
1 parent eda903c commit a53ba1d

File tree

1 file changed

+12
-2
lines changed

1 file changed

+12
-2
lines changed

README.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
`petite-vue` is an alternative distribution of Vue optimized for progressive enhancement. It provides the same template syntax and reactivity mental model with standard Vue. However, it is specifically optimized for "sprinkling" small amount of interactions on an existing HTML page rendered by a server framework. See more details in [how it differs from standard Vue](#comparison-with-standard-vue).
44

5-
- Only ~5.8kb
5+
- Only ~6kb
66
- Vue-compatible template syntax
77
- DOM-based, mutates in place
88
- Driven by `@vue/reactivity`
@@ -296,6 +296,16 @@ const html = ({ el, get, effect }) => {
296296
}
297297
```
298298

299+
### Custom Delimiters (0.3+)
300+
301+
You can use custom delimiters by passing `$delimiters` to your root scope. This is useful when working alongside a server-side templating language that also uses mustaches:
302+
303+
```js
304+
createApp({
305+
$delimiters: ['${', '}']
306+
}).mount()
307+
```
308+
299309
## Examples
300310

301311
Check out the [examples directory](https://github.com/vuejs/petite-vue/tree/main/examples).
@@ -317,7 +327,7 @@ Check out the [examples directory](https://github.com/vuejs/petite-vue/tree/main
317327

318328
### Vue Compatible
319329

320-
- `{{ }}` text bindings
330+
- `{{ }}` text bindings (configurable with custom delimiters)
321331
- `v-bind` (including `:` shorthand and class/style special handling)
322332
- `v-on` (including `@` shorthand and all modifiers)
323333
- `v-model` (all input types + non-string `:value` bindings)

0 commit comments

Comments
 (0)