Skip to content

Commit

Permalink
Documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
MWDelaney committed Sep 21, 2013
1 parent 9bb8847 commit a6dfc40
Showing 1 changed file with 48 additions and 3 deletions.
51 changes: 48 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,11 +87,15 @@ push-lg | Push on column on large screens | optional | 1-12 | false
### Lead body copy
[lead] … [/lead]

#### [lead] parameters
None

[Bootstrap body copy documentation](http://getbootstrap.com/css/#type-body-copy)

### Emphasis classes
[emphasis type="success"] … [/emphasis]

#### [emphasis] parameters
Parameter | Description | Required | Values | Default
--- | --- | --- | --- | ---
type | The type of label to display | required | muted, primary, success, info, warning, danger | muted
Expand All @@ -101,6 +105,7 @@ type | The type of label to display | required | muted, primary, success, info,
### Code
[code] … [/code]

#### [code] parameters
Parameter | Description | Required | Values | Default
--- | --- | --- | --- | ---
inline | Display inline code | optional | true, false | false
Expand All @@ -111,11 +116,14 @@ scrollable | Set a max height of 350px and provide a scroll bar. Not usable with
### Tables
[table type="striped" cols="#,First Name, Last Name, Username" data="1, Filip, Stefansson, filipstefansson, 2, Victor, Meyer, Pudge, 3, Måns, Ketola-Backe, mossboll"]

#### [table] parameters

[Bootstrap table documentation](http://getbootstrap.com/css/#tables)

### Buttons
[button type="success" size="lg" link="#"] … [/button]

#### [button] parameters
Parameter | Description | Required | Values | Default
--- | --- | --- | --- | ---
type | The type of the button | optional | default, primary, success, info, warning, danger, link | default
Expand All @@ -132,6 +140,7 @@ data | Data attribute and value pairs separated by a comma. Pairs separated by p
### Responsive Utilities
[responsive visible="sm xs" hidden="lg"] … [/responsive]

#### [reponsive] parameters
Parameter | Description | Required | Values | Default
--- | --- | --- | --- | ---
visible | Sizes at which this element is visible (separated by spaces) | optional | xs, sm, md, lg | false
Expand All @@ -144,6 +153,7 @@ hidden | Sizes at which this element is hidden (separated by spaces) | optional
### Icons
[icon type="arrow"]

#### [icon] parameters
Parameter | Description | Required | Values | Default
--- | --- | --- | --- | ---
type | The type of icon you want to display | required | See Bootstrap docs | none
Expand All @@ -156,7 +166,8 @@ type | The type of icon you want to display | required | See Bootstrap docs | no
[button link="#"] … [/button]
[button link="#"] … [/button]
[/button-group]


#### [button-group] parameters
Parameter | Description | Required | Values | Default
--- | --- | --- | --- | ---
size | The size of the button group | optional | xs, sm, lg | none
Expand All @@ -168,6 +179,7 @@ vertical | Whether button group is vertical | optional | true, false | false
### Labels
[label type="success"] … [/label]

#### [label] parameters
Parameter | Description | Required | Values | Default
--- | --- | --- | --- | ---
type | The type of label to display | optional | default, primary, success, info, warning, danger | default
Expand All @@ -177,6 +189,7 @@ type | The type of label to display | optional | default, primary, success, info
### Badges
[badge right="true"] … [/badge]

#### [badge] parameters
Parameter | Description | Required | Values | Default
--- | --- | --- | --- | ---
right | Whether the badge should align to the right of its container | optional | true, false | false
Expand All @@ -186,6 +199,7 @@ right | Whether the badge should align to the right of its container | optional
### Jumbotron
[jumbotron title="My Jumbotron"] … [/jumbotron]

#### [jumbotron] parameters
Parameter | Description | Required | Values | Default
--- | --- | --- | --- | ---
title | The jumbotron title | optional | Any text | none
Expand All @@ -196,12 +210,16 @@ title | The jumbotron title | optional | Any text | none
[thumbnail] … [/thumbnail]
[thumbnail] … [/thumbnail]
[thumbnail] … [/thumbnail]


#### [thumbnail] parameters
None

[Bootstrap thumbnails documentation](http://getbootstrap.com/components/#thumbnails)

### Alerts
[alert type="success"] … [/alert]

#### [alert] parameters
Parameter | Description | Required | Values | Default
--- | --- | --- | --- | ---
type | The type of the alert | required | success, info, warning, danger | success
Expand All @@ -220,9 +238,17 @@ strong | Text to display in bold at the beginning | optional | any text | false
[/media-body]
[/media]

#### [media] parameters
None

#### [media-object] parameters
Parameter | Description | Required | Values | Default
--- | --- | --- | --- | ---
pull | Whether the image pulls to the left or right | optional | left, right | right

#### [media-body] parameters
Parameter | Description | Required | Values | Default
--- | --- | --- | --- | ---
title | The object title | required | Any text | none

__NOTE: media-object should contain an image, or linked image, inserted using the WordPress TinyMCE editor__
Expand All @@ -242,11 +268,15 @@ __NOTE: media-object should contain an image, or linked image, inserted using th
[/list-group-item]
[/list-group]

#### [list-group] parameters
None

[Bootstrap list groups documentation](http://getbootstrap.com/components/#list-group)

### Panels
[panel type="info" title="Panel Title" footer="Footer text"] … [/panel]

#### [panel] parameters
Parameter | Description | Required | Values | Default
--- | --- | --- | --- | ---
type | The type of the panel | optional | default, primary, success, info, warning, danger, link | default
Expand All @@ -258,6 +288,7 @@ footer | The panel footer text if desired | optional | any text | none
### Wells
[well size="small"] … [/well]

#### [well] parameters
Parameter | Description | Required | Values | Default
--- | --- | --- | --- | ---
size | Modifies the amount of padding inside the well | optional | sm, lg | normal
Expand All @@ -279,6 +310,10 @@ size | Modifies the amount of padding inside the well | optional | sm, lg | norm
[/tab]
[/tabs]

#### [tabs] parameters
None

#### [tab] parameters
Parameter | Description | Required | Values | Default
--- | --- | --- | --- | ---
title | The title of the tab | required | any text | false
Expand All @@ -288,6 +323,7 @@ title | The title of the tab | required | any text | false
### Tooltip
[tooltip title="I'm the title" placement="right"] … [/tooltip]

#### [tooltip] parameters
Parameter | Description | Required | Values | Default
--- | --- | --- | --- | ---
title | The text of the tooltip | required | any text | none
Expand All @@ -300,6 +336,7 @@ html | Insert HTML into the tooltip | optional | true, false | false
### Popover
[popover title="I'm the title" content="And here's some amazing content. It's very engaging. right?" placement="right"] … [/popover]

#### [popover] parameters
Parameter | Description | Required | Values | Default
--- | --- | --- | --- | ---
title | The title of the popover | optional | any text | none
Expand All @@ -322,7 +359,11 @@ html | Insert HTML into the tooltip | optional | true, false | false
[/collapse]
[/collapsibles]


#### [collapsibles] parameters
None

#### [collapse] parameters
Parameter | Description | Required | Values | Default
--- | --- | --- | --- | ---
title | The title of the collapsible, visible when collapsed | required | any text | false
Expand All @@ -338,10 +379,14 @@ active | Whether the tab is expanded at load time | optional | active | false
[/modal-footer]
[/modal]

#### [modal] parameters
Parameter | Description | Required | Values | Default
--- | --- | --- | --- | ---
text | Text of the modal trigger link | required | any text | none
title | Title of the modal popup | required | any text | none
xclass | Any extra classes you want to add to the trigger link | optional | any text | none

#### [modal-footer] parameters
None

[Bootstrap modal documentation](http://getbootstrap.com/javascript/#modals)

0 comments on commit a6dfc40

Please sign in to comment.