Skip to content

Commit

Permalink
feat(documentation) Styled npm installation instructions
Browse files Browse the repository at this point in the history
[#98751316]
  • Loading branch information
Kenny Wang and Tyler Phelan committed Jul 10, 2015
1 parent ffade41 commit aff1dfc
Show file tree
Hide file tree
Showing 38 changed files with 260 additions and 262 deletions.
14 changes: 6 additions & 8 deletions src/pivotal-ui/components/alerts/alerts.scss
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,10 @@ categories:
- All
---
Install the component:
```
<code class="pam">
<i class="fa fa-download" alt="Install the Component"></i>
npm install pui-css-alerts --save
```
</code>
Alerts are used to display flash messages to the user. When using alerts with simple one-line
text, wrap the text in a `<p>` with `.em-high`.
Expand Down Expand Up @@ -210,11 +209,10 @@ categories:
- React Beta
---
Install the component:
```
<code class="pam">
<i class="fa fa-download" alt="Install the Component"></i>
npm install pui-react-alerts --save
```
</code>
Require the subcomponent:
Expand Down
7 changes: 3 additions & 4 deletions src/pivotal-ui/components/alignment/alignment.scss
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,10 @@ categories:
- All
---
Install the component:
```
<code class="pam">
<i class="fa fa-download" alt="Install the Component"></i>
npm install pui-react-alignment --save
```
</code>
The following classes can be used to for horizontal alignment.
Expand Down
8 changes: 4 additions & 4 deletions src/pivotal-ui/components/avatars/avatars.scss
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,11 @@ categories:
- All
---
Install the component:
```
<code class="pam">
<i class="fa fa-download" alt="Install the Component">
npm install pui-css-avatars --save
```
</i>
</code>
Regular avatars are expected to by 100px by 100px.
Expand Down
31 changes: 16 additions & 15 deletions src/pivotal-ui/components/back-to-top/back-to-top.scss
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,11 @@ categories:
- All
---
Install the component:
```
<code class="pam">
<i class="fa fa-download" alt="Install the Component">
npm install pui-css-back-to-top --save
```
</i>
</code>
You can use this component to scroll to the top of a page.
Expand All @@ -34,23 +34,24 @@ categories:
- React Beta
---
You can use this component to scroll to the top of a page.
The button will be fixed to the bottom right hand corner of the page.
You can place the link anywhere in your markup, but best practices are either towards the top or bottom of your markup.
<code class="pam">
<i class="fa fa-download" alt="Install the Component">
npm install pui-react-back-to-top --save
</i>
</code>
Install the component:
Require the subcomponent:
```
npm install pui-react-back-to-top --save
var BackToTop = require('pui-react-back-to-top').BackToTop;
```
Require the component:
You can use this component to scroll to the top of a page.
The button will be fixed to the bottom right hand corner of the page.
You can place the link anywhere in your markup, but best practices are either towards the top or bottom of your markup.
```
var BackToTop = require('pui-react-back-to-top');
```
```react_wrapped_example
Expand Down
8 changes: 4 additions & 4 deletions src/pivotal-ui/components/backgrounds/backgrounds.scss
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,11 @@ categories:
- All
---
Install the component:
```
<code class="pam">
<i class="fa fa-download" alt="Install the Component">
npm install pui-css-backgrounds --save
```
</i>
</code>
Background color classes can be applied to any element. See [colors][color] for a list of background classes.
Expand Down
16 changes: 8 additions & 8 deletions src/pivotal-ui/components/buttons/buttons.scss
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,11 @@ categories:
- All
---
Install the component:
```
<code class="pam">
<i class="fa fa-download" alt="Install the Component">
npm install pui-css-buttons --save
```
</i>
</code>
Button styles can be applied to any element. Typically you'll want to
use either a `<button>` or an `<a>` element:
Expand Down Expand Up @@ -149,11 +149,11 @@ categories:
- React Beta
---
Install the component:
```
<code class="pam">
<i class="fa fa-download" alt="Install the Component">
npm install pui-react-buttons --save
```
</i>
</code>
Require the subcomponent:
Expand Down
8 changes: 4 additions & 4 deletions src/pivotal-ui/components/code/code.scss
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,11 @@ categories:
- All
---
Install the component:
```
<code class="pam">
<i class="fa fa-download" alt="Install the Component">
npm install pui-css-code --save
```
</i>
</code>
This is your basic unstyled code sample:
Expand Down
16 changes: 8 additions & 8 deletions src/pivotal-ui/components/collapse/collapse.scss
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,11 @@ categories:
- All
---
Install the component:
```
<code class="pam">
<i class="fa fa-download" alt="Install the Component">
npm install pui-css-collapse --save
```
</i>
</code>
These are frequently used in combination with our panel components. They have a header and body.
Expand Down Expand Up @@ -298,11 +298,11 @@ categories:
- React Beta
---
Install the component:
```
<code class="pam">
<i class="fa fa-download" alt="Install the Component">
npm install pui-react-collapse --save
```
</i>
</code>
Require the subcomponent:
Expand Down
8 changes: 4 additions & 4 deletions src/pivotal-ui/components/colors/colors.scss
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,11 @@ categories:
- All
---
Install the component:
```
<code class="pam">
<i class="fa fa-download" alt="Install the Component">
npm install pui-css-colors --save
```
</i>
</code>
Expand Down
16 changes: 8 additions & 8 deletions src/pivotal-ui/components/dividers/dividers.scss
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,11 @@ categories:
- All
---
Install the component:
```
<code class="pam">
<i class="fa fa-download" alt="Install the Component">
npm install pui-css-dividers --save
```
</i>
</code>
Dividers draw horizontal lines between different content groupings.
Expand Down Expand Up @@ -62,11 +62,11 @@ categories:
- React Beta
---
Install the component:
```
<code class="pam">
<i class="fa fa-download" alt="Install the Component">
npm install pui-react-dividers --save
```
</i>
</code>
Require the subcomponent:
Expand Down
30 changes: 15 additions & 15 deletions src/pivotal-ui/components/dropdowns/dropdowns.scss
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,11 @@ categories:
- All
---
Install the component:
```
<code class="pam">
<i class="fa fa-download" alt="Install the Component">
npm install pui-css-dropdowns --save
```
</i>
</code>
Dropdowns are menus that can be triggered by buttons.
Expand Down Expand Up @@ -144,13 +144,13 @@ categories:
- React Beta
---
Install the component:
```
<code class="pam">
<i class="fa fa-download" alt="Install the Component">
npm install pui-react-dropdowns --save
```
</i>
</code>
Require the component:
Require the subcomponent:
```
var Dropdown = require('pui-react-dropdowns').Dropdown;
Expand Down Expand Up @@ -493,13 +493,13 @@ categories:
- React Beta
---
Install the component:
```
<code class="pam">
<i class="fa fa-download" alt="Install the Component">
npm install pui-react-notifications --save
```
</i>
</code>
Require the component:
Require the subcomponent:
```
var Notifications = require('pui-react-notifications');
Expand Down Expand Up @@ -538,7 +538,7 @@ name: alert_notifications_react
parent: notifications_react
---
Require the component:
Require the subcomponent:
```
var AlertNotifications = require('pui-react-notifications').AlertNotifications;
Expand Down
8 changes: 4 additions & 4 deletions src/pivotal-ui/components/ellipsis/ellipsis.scss
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,11 @@ categories:
---
Install the component:
```
<code class="pam">
<i class="fa fa-download" alt="Install the Component">
npm install pui-css-ellipsis --save
```
</i>
</code>
The type `.type-ellipsis-1-line` adds ellipsis to text when there is too much. Combine it with `.col-md-*` classes to get the width you want.
Expand Down
8 changes: 4 additions & 4 deletions src/pivotal-ui/components/embeds/embeds.scss
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,11 @@ parent: embed
---
Install the component:
```
<code class="pam">
<i class="fa fa-download" alt="Install the Component">
npm install pui-css-embeds --save
```
</i>
</code>
Allow browsers to determine video or slideshow dimensions based on the width of their containing block by creating an intrinsic ratio that will properly scale on any device.
Expand Down
10 changes: 5 additions & 5 deletions src/pivotal-ui/components/expander/expander.scss
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,13 @@ categories:
---
Install the component:
```
<code class="pam">
<i class="fa fa-download" alt="Install the Component">
npm install pui-react-expander --save
```
</i>
</code>
Require the component:
Require the subcomponent:
```
var ExpanderContent = require('pui-react-expander').ExpanderContent;
Expand Down
Loading

0 comments on commit aff1dfc

Please sign in to comment.