Skip to content

Commit e0d8b8a

Browse files
committed
README
1 parent 3083eba commit e0d8b8a

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

README.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,12 +17,16 @@ With Theo, you can render a partial using HTML-like syntax:
1717
```
1818

1919

20-
## Installation
20+
## Getting started
21+
22+
### Installation
2123

2224
Run
2325

2426
gem install theo-rails
2527

28+
### Configuration
29+
2630
If you are using TailwindCSS, add `.theo` extension to the `content` key in your `tailwind.config.js`:
2731

2832
'./app/views/**/*.{erb,haml,html,slim,theo}'
@@ -81,7 +85,7 @@ Rendering a partial in ERB requires switching between HTML markup and Ruby code,
8185

8286
In Theo, you render a partial by writing a tag with `_` prefix, for example:
8387
```html
84-
<_button size="large" />`
88+
<_button size="large" />
8589
```
8690
is equivalent to:
8791
```erb
@@ -258,7 +262,7 @@ Components can also include content:
258262
</Button>
259263
```
260264
and yield a value:
261-
```
265+
```html
262266
<Button size="large" yields="component">
263267
<% component.with_header do %>Icon<% end %>
264268
Create

0 commit comments

Comments
 (0)