some more README cleanup and modified the styling recommendation [ski…

…p ci]
enigma-io · Mar 14, 2017 · 9a64145 · 9a64145
1 parent f7af77d
commit 9a64145
Show file tree

Hide file tree

Showing 20 changed files with 29 additions and 97 deletions.
diff --git a/packages/boundless-async/README.md b/packages/boundless-async/README.md
@@ -63,11 +63,11 @@ import { Async } from 'boundless';
           </ul>
       );
   });
-  ```
 
   <Async>{listDataPromise}</Async>
+  ```
 
-  Function example:
+  Function example, reading in `[data-endpoint]` as the `window.fetch()` target:
 
   ```jsx
   const fetchListData = (props) => fetch(props['data-endpoint']).then(
@@ -117,10 +117,7 @@ import { Async } from 'boundless';
 ## Reference Styles
 ### Stylus
 ```stylus
-// Bring in Boundless's base Stylus variables
-@require "node_modules/boundless-async/variables"
-
-// Redefine any variables as desired, e.g.
+// Redefine any variables as desired (you can see what's available in [variables.styl](https://github.com/enigma-io/boundless/blob/master/variables.styl)), e.g.
 color-accent = royalblue
 
 // Bring in the component styles; they will be autoconfigured based on the above

diff --git a/packages/boundless-async/build/index.js b/packages/boundless-async/build/index.js
diff --git a/packages/boundless-async/index.js b/packages/boundless-async/index.js
@@ -39,11 +39,11 @@ export default class Async extends PureComponent {
          *         </ul>
          *     );
          * });
-         * ```
          *
          * <Async>{listDataPromise}</Async>
+         * ```
          *
-         * Function example:
+         * Function example, reading in `[data-endpoint]` as the `window.fetch()` target:
          *
          * ```jsx
          * const fetchListData = (props) => fetch(props['data-endpoint']).then(

diff --git a/packages/boundless-button/README.md b/packages/boundless-button/README.md
@@ -149,10 +149,7 @@ There are no required props.
 ## Reference Styles
 ### Stylus
 ```stylus
-// Bring in Boundless's base Stylus variables
-@require "node_modules/boundless-button/variables"
-
-// Redefine any variables as desired, e.g.
+// Redefine any variables as desired (you can see what's available in [variables.styl](https://github.com/enigma-io/boundless/blob/master/variables.styl)), e.g.
 color-accent = royalblue
 
 // Bring in the component styles; they will be autoconfigured based on the above

diff --git a/packages/boundless-checkbox-group/README.md b/packages/boundless-checkbox-group/README.md
@@ -208,10 +208,7 @@ import { CheckboxGroup } from 'boundless';
 ## Reference Styles
 ### Stylus
 ```stylus
-// Bring in Boundless's base Stylus variables
-@require "node_modules/boundless-checkbox-group/variables"
-
-// Redefine any variables as desired, e.g.
+// Redefine any variables as desired (you can see what's available in [variables.styl](https://github.com/enigma-io/boundless/blob/master/variables.styl)), e.g.
 color-accent = royalblue
 
 // Bring in the component styles; they will be autoconfigured based on the above

diff --git a/packages/boundless-checkbox/README.md b/packages/boundless-checkbox/README.md
@@ -108,10 +108,7 @@ There are no required props.
 
   Expects | Default Value
   ---     | ---
-  `object` | `{
-    checked: false,
-    indeterminate: false,
-}`
+  `object` | `{ checked: false, indeterminate: false }`
 
 - __`label`__ &middot; any React-renderable content, most commonly a simple string
 
@@ -141,10 +138,7 @@ There are no required props.
 ## Reference Styles
 ### Stylus
 ```stylus
-// Bring in Boundless's base Stylus variables
-@require "node_modules/boundless-checkbox/variables"
-
-// Redefine any variables as desired, e.g.
+// Redefine any variables as desired (you can see what's available in [variables.styl](https://github.com/enigma-io/boundless/blob/master/variables.styl)), e.g.
 color-accent = royalblue
 
 // Bring in the component styles; they will be autoconfigured based on the above

diff --git a/packages/boundless-dialog/README.md b/packages/boundless-dialog/README.md
@@ -196,10 +196,7 @@ There are no required props.
 ## Reference Styles
 ### Stylus
 ```stylus
-// Bring in Boundless's base Stylus variables
-@require "node_modules/boundless-dialog/variables"
-
-// Redefine any variables as desired, e.g.
+// Redefine any variables as desired (you can see what's available in [variables.styl](https://github.com/enigma-io/boundless/blob/master/variables.styl)), e.g.
 color-accent = royalblue
 
 // Bring in the component styles; they will be autoconfigured based on the above

diff --git a/packages/boundless-fitted-text/README.md b/packages/boundless-fitted-text/README.md
@@ -92,10 +92,7 @@ There are no required props.
 ## Reference Styles
 ### Stylus
 ```stylus
-// Bring in Boundless's base Stylus variables
-@require "node_modules/boundless-fitted-text/variables"
-
-// Redefine any variables as desired, e.g.
+// Redefine any variables as desired (you can see what's available in [variables.styl](https://github.com/enigma-io/boundless/blob/master/variables.styl)), e.g.
 color-accent = royalblue
 
 // Bring in the component styles; they will be autoconfigured based on the above

diff --git a/packages/boundless-image/README.md b/packages/boundless-image/README.md
@@ -131,10 +131,7 @@ import { Image } from 'boundless';
 ## Reference Styles
 ### Stylus
 ```stylus
-// Bring in Boundless's base Stylus variables
-@require "node_modules/boundless-image/variables"
-
-// Redefine any variables as desired, e.g.
+// Redefine any variables as desired (you can see what's available in [variables.styl](https://github.com/enigma-io/boundless/blob/master/variables.styl)), e.g.
 color-accent = royalblue
 
 // Bring in the component styles; they will be autoconfigured based on the above

diff --git a/packages/boundless-input/README.md b/packages/boundless-input/README.md
@@ -123,18 +123,13 @@ There are no required props.
 
   Expects | Default Value
   ---     | ---
-  `object` | `{
-    type: 'text',
-}`
+  `object` | `{ type: 'text' }`
 
 
 ## Reference Styles
 ### Stylus
 ```stylus
-// Bring in Boundless's base Stylus variables
-@require "node_modules/boundless-input/variables"
-
-// Redefine any variables as desired, e.g.
+// Redefine any variables as desired (you can see what's available in [variables.styl](https://github.com/enigma-io/boundless/blob/master/variables.styl)), e.g.
 color-accent = royalblue
 
 // Bring in the component styles; they will be autoconfigured based on the above

diff --git a/packages/boundless-modal/README.md b/packages/boundless-modal/README.md
@@ -190,10 +190,7 @@ There are no required props.
 ## Reference Styles
 ### Stylus
 ```stylus
-// Bring in Boundless's base Stylus variables
-@require "node_modules/boundless-modal/variables"
-
-// Redefine any variables as desired, e.g.
+// Redefine any variables as desired (you can see what's available in [variables.styl](https://github.com/enigma-io/boundless/blob/master/variables.styl)), e.g.
 color-accent = royalblue
 
 // Bring in the component styles; they will be autoconfigured based on the above

diff --git a/packages/boundless-pagination/README.md b/packages/boundless-pagination/README.md
@@ -304,10 +304,7 @@ import { Pagination } from 'boundless';
 ## Reference Styles
 ### Stylus
 ```stylus
-// Bring in Boundless's base Stylus variables
-@require "node_modules/boundless-pagination/variables"
-
-// Redefine any variables as desired, e.g.
+// Redefine any variables as desired (you can see what's available in [variables.styl](https://github.com/enigma-io/boundless/blob/master/variables.styl)), e.g.
 color-accent = royalblue
 
 // Bring in the component styles; they will be autoconfigured based on the above

diff --git a/packages/boundless-popover/README.md b/packages/boundless-popover/README.md
@@ -252,12 +252,7 @@ import { Popover } from 'boundless';
 
   Expects | Default Value
   ---     | ---
-  `ReactElement` | `<svg viewBox='0 0 14 9.5' xmlns='http://www.w3.org/2000/svg'>
-    <g>
-        <polygon className='b-popover-caret-border' fill='#000' points='7 0 14 10 0 10' />
-        <polygon className='b-popover-caret-fill' fill='#FFF' points='6.98230444 1.75 12.75 10 1.25 10' />
-    </g>
-</svg>`
+  `ReactElement` | `<svg viewBox='0 0 14 9.5' xmlns='http://www.w3.org/2000/svg'> <g> <polygon className='b-popover-caret-border' fill='#000' points='7 0 14 10 0 10' /> <polygon className='b-popover-caret-fill' fill='#FFF' points='6.98230444 1.75 12.75 10 1.25 10' /> </g></svg>`
 
 - __`closeOnEscKey`__ &middot; enable detection of "Escape" keypresses to trigger `props.onClose`; if a function is provided, the return
   value determines if the dialog will be closed
@@ -341,10 +336,7 @@ import { Popover } from 'boundless';
 ## Reference Styles
 ### Stylus
 ```stylus
-// Bring in Boundless's base Stylus variables
-@require "node_modules/boundless-popover/variables"
-
-// Redefine any variables as desired, e.g.
+// Redefine any variables as desired (you can see what's available in [variables.styl](https://github.com/enigma-io/boundless/blob/master/variables.styl)), e.g.
 color-accent = royalblue
 
 // Bring in the component styles; they will be autoconfigured based on the above

diff --git a/packages/boundless-progress/README.md b/packages/boundless-progress/README.md
@@ -179,10 +179,7 @@ There are no required props.
 ## Reference Styles
 ### Stylus
 ```stylus
-// Bring in Boundless's base Stylus variables
-@require "node_modules/boundless-progress/variables"
-
-// Redefine any variables as desired, e.g.
+// Redefine any variables as desired (you can see what's available in [variables.styl](https://github.com/enigma-io/boundless/blob/master/variables.styl)), e.g.
 color-accent = royalblue
 
 // Bring in the component styles; they will be autoconfigured based on the above

diff --git a/packages/boundless-progressive-disclosure/README.md b/packages/boundless-progressive-disclosure/README.md
@@ -124,10 +124,7 @@ There are no required props.
 ## Reference Styles
 ### Stylus
 ```stylus
-// Bring in Boundless's base Stylus variables
-@require "node_modules/boundless-progressive-disclosure/variables"
-
-// Redefine any variables as desired, e.g.
+// Redefine any variables as desired (you can see what's available in [variables.styl](https://github.com/enigma-io/boundless/blob/master/variables.styl)), e.g.
 color-accent = royalblue
 
 // Bring in the component styles; they will be autoconfigured based on the above

diff --git a/packages/boundless-radio/README.md b/packages/boundless-radio/README.md
@@ -160,10 +160,7 @@ import { Radio } from 'boundless';
 ## Reference Styles
 ### Stylus
 ```stylus
-// Bring in Boundless's base Stylus variables
-@require "node_modules/boundless-radio/variables"
-
-// Redefine any variables as desired, e.g.
+// Redefine any variables as desired (you can see what's available in [variables.styl](https://github.com/enigma-io/boundless/blob/master/variables.styl)), e.g.
 color-accent = royalblue
 
 // Bring in the component styles; they will be autoconfigured based on the above

diff --git a/packages/boundless-segmented-control/README.md b/packages/boundless-segmented-control/README.md
@@ -161,10 +161,7 @@ import { SegmentedControl } from 'boundless';
 ## Reference Styles
 ### Stylus
 ```stylus
-// Bring in Boundless's base Stylus variables
-@require "node_modules/boundless-segmented-control/variables"
-
-// Redefine any variables as desired, e.g.
+// Redefine any variables as desired (you can see what's available in [variables.styl](https://github.com/enigma-io/boundless/blob/master/variables.styl)), e.g.
 color-accent = royalblue
 
 // Bring in the component styles; they will be autoconfigured based on the above

diff --git a/packages/boundless-tokenized-input/README.md b/packages/boundless-tokenized-input/README.md
@@ -203,9 +203,7 @@ There are no required props.
 
   Expects | Default Value
   ---     | ---
-  `object` | `{
-    type: 'text',
-}`
+  `object` | `{ type: 'text' }`
 
 - __`matchWrapperProps`__
 
@@ -268,10 +266,7 @@ There are no required props.
 ## Reference Styles
 ### Stylus
 ```stylus
-// Bring in Boundless's base Stylus variables
-@require "node_modules/boundless-tokenized-input/variables"
-
-// Redefine any variables as desired, e.g.
+// Redefine any variables as desired (you can see what's available in [variables.styl](https://github.com/enigma-io/boundless/blob/master/variables.styl)), e.g.
 color-accent = royalblue
 
 // Bring in the component styles; they will be autoconfigured based on the above

diff --git a/packages/boundless-typeahead/README.md b/packages/boundless-typeahead/README.md
@@ -220,9 +220,7 @@ There are no required props.
 
   Expects | Default Value
   ---     | ---
-  `object` | `{
-    type: 'text',
-}`
+  `object` | `{ type: 'text' }`
 
 - __`matchWrapperProps`__
 
@@ -260,10 +258,7 @@ There are no required props.
 ## Reference Styles
 ### Stylus
 ```stylus
-// Bring in Boundless's base Stylus variables
-@require "node_modules/boundless-typeahead/variables"
-
-// Redefine any variables as desired, e.g.
+// Redefine any variables as desired (you can see what's available in [variables.styl](https://github.com/enigma-io/boundless/blob/master/variables.styl)), e.g.
 color-accent = royalblue
 
 // Bring in the component styles; they will be autoconfigured based on the above

diff --git a/scripts/build-packages.js b/scripts/build-packages.js
@@ -105,18 +105,15 @@ There are no required props.
 
   Expects | Default Value
   ---     | ---
-  \`<%= typeParser(props[propName].type) %>\` | \`<%= _.get(props[propName], 'defaultValue.value', 'n/a') %>\`
+  \`<%= typeParser(props[propName].type) %>\` | \`<%= _.get(props[propName], 'defaultValue.value', 'n/a').replace(/\\n/g, '').replace(/(\\n|\\s{2,})/g, ' ').replace(/,\}/g, ' }') %>\`
 <% }) } else { %>
 There are no optional props.
 <% } } %>
 <% if (hasStyles) { %>
 ## Reference Styles
 ### Stylus
 \`\`\`stylus
-// Bring in Boundless's base Stylus variables
-@require "node_modules/<%= name %>/variables"
-
-// Redefine any variables as desired, e.g.
+// Redefine any variables as desired (you can see what's available in [variables.styl](https://github.com/enigma-io/boundless/blob/master/variables.styl)), e.g.
 color-accent = royalblue
 
 // Bring in the component styles; they will be autoconfigured based on the above