Skip to content

Commit c0b0d9d

Browse files
committed
adds aside documentation
1 parent e561fa0 commit c0b0d9d

File tree

1 file changed

+31
-0
lines changed

1 file changed

+31
-0
lines changed

docs/components/aside.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# matestack core component: Aside
2+
3+
Show [specs](/spec/usage/components/aside_spec.rb)
4+
5+
The HTML `<aside>` tag implemented in ruby.
6+
7+
## Parameters
8+
9+
This component can take 2 optional configuration params and optional content.
10+
11+
#### # id (optional)
12+
Expects a string with all ids the p should have.
13+
14+
#### # class (optional)
15+
Expects a string with all classes the p should have.
16+
17+
## Example 1
18+
19+
```ruby
20+
aside id: "foo", class: "bar" do
21+
paragraph text: "This is some text"
22+
end
23+
```
24+
25+
returns
26+
27+
```html
28+
<aside id="foo" class="bar">
29+
<p>This is some text</p>
30+
</aside>
31+
```

0 commit comments

Comments
 (0)