Skip to content

Commit

Permalink
Docs: Update examples syntax
Browse files Browse the repository at this point in the history
  • Loading branch information
sapegin committed Jul 14, 2017
1 parent c944683 commit 88724cd
Show file tree
Hide file tree
Showing 21 changed files with 96 additions and 50 deletions.
4 changes: 3 additions & 1 deletion examples/basic/src/components/CounterButton/Readme.md
@@ -1 +1,3 @@
<CounterButton/>
```js
<CounterButton/>
```
22 changes: 13 additions & 9 deletions examples/basic/src/components/Modal/Readme.md
@@ -1,14 +1,18 @@
Each example has its own state that you can access at the `state` variable and change with the `setState` function. Default state is `{}`.

<div>
<button onClick={() => setState({isOpen: true})}>Open</button>
<Modal isOpen={state.isOpen}>
<h1>Hallo!</h1>
<button onClick={() => setState({isOpen: false})}>Close</button>
</Modal>
</div>
```jsx
<div>
<button onClick={() => setState({isOpen: true})}>Open</button>
<Modal isOpen={state.isOpen}>
<h1>Hallo!</h1>
<button onClick={() => setState({isOpen: false})}>Close</button>
</Modal>
</div>
```

If you want to set the default state you can do something like that:

initialState = {count: 1};
<button onClick={() => setState({count: state.count+1})}>{state.count}</button>
```jsx
initialState = {count: 1};
<button onClick={() => setState({count: state.count+1})}>{state.count}</button>
```
4 changes: 3 additions & 1 deletion examples/basic/src/components/Placeholder/Readme.md
@@ -1 +1,3 @@
<Placeholder type="beard"/>
```jsx
<Placeholder type="beard"/>
```
6 changes: 4 additions & 2 deletions examples/basic/src/components/RandomButton/Readme.md
@@ -1,4 +1,6 @@
You can `require` external files in your examples:

const names = require('dog-names').all;
<RandomButton variants={names}/>
```jsx
const names = require('dog-names').all;
<RandomButton variants={names}/>
```
4 changes: 3 additions & 1 deletion examples/basic/src/components/WrappedButton/Readme.md
@@ -1,3 +1,5 @@
Enhanced/Decorated components work as well:

<WrappedButton>I'm a wrapped button</WrappedButton>
```jsx
<WrappedButton>I'm a wrapped button</WrappedButton>
```
4 changes: 3 additions & 1 deletion examples/cra/src/components/Placeholder.md
@@ -1 +1,3 @@
<Placeholder type="beard"/>
```jsx
<Placeholder type="beard"/>
```
6 changes: 4 additions & 2 deletions examples/cra/src/components/RandomButton.md
@@ -1,4 +1,6 @@
You can `require` external files in your examples:

const names = require('dog-names').all;
<RandomButton variants={names}/>
```jsx
const names = require('dog-names').all;
<RandomButton variants={names}/>
```
22 changes: 13 additions & 9 deletions examples/customised/src/components/Modal/Readme.md
@@ -1,14 +1,18 @@
Each example has its own state that you can access at the `state` variable and change with the `setState` function. Default state is `{}`.

<div>
<button onClick={() => setState({isOpen: true})}>Open</button>
<Modal isOpen={state.isOpen}>
<h1>Hallo!</h1>
<button onClick={() => setState({isOpen: false})}>Close</button>
</Modal>
</div>
```jsx
<div>
<button onClick={() => setState({isOpen: true})}>Open</button>
<Modal isOpen={state.isOpen}>
<h1>Hallo!</h1>
<button onClick={() => setState({isOpen: false})}>Close</button>
</Modal>
</div>
```

If you want to set the default state you can do something like that:

initialState = {count: 1};
<button onClick={() => setState({count: state.count+1})}>{state.count}</button>
```jsx
initialState = {count: 1};
<button onClick={() => setState({count: state.count+1})}>{state.count}</button>
```
4 changes: 3 additions & 1 deletion examples/customised/src/components/Placeholder/Readme.md
@@ -1 +1,3 @@
<Placeholder type="beard"/>
```jsx
<Placeholder type="beard"/>
```
6 changes: 4 additions & 2 deletions examples/customised/src/components/RandomButton/Readme.md
@@ -1,4 +1,6 @@
You can `require` external files in your examples:

const names = require('dog-names').all;
<RandomButton variants={names}/>
```jsx
const names = require('dog-names').all;
<RandomButton variants={names}/>
```
2 changes: 1 addition & 1 deletion examples/express/src/components/CustomEndpoint/Readme.md
Expand Up @@ -2,6 +2,6 @@ Custom Endpoint Example

The example component invokes an endpoint added to the running styleguide server.

```example
```js
<CustomEndpoint />
```
4 changes: 3 additions & 1 deletion examples/preact/src/components/CounterButton/Readme.md
@@ -1 +1,3 @@
<CounterButton/>
```jsx
<CounterButton/>
```
22 changes: 13 additions & 9 deletions examples/preact/src/components/Modal/Readme.md
@@ -1,14 +1,18 @@
Each example has its own state that you can access at the `state` variable and change with the `setState` function. Default state is `{}`.

<div>
<button onClick={() => setState({isOpen: true})}>Open</button>
<Modal isOpen={state.isOpen}>
<h1>Hallo!</h1>
<button onClick={() => setState({isOpen: false})}>Close</button>
</Modal>
</div>
```jsx
<div>
<button onClick={() => setState({isOpen: true})}>Open</button>
<Modal isOpen={state.isOpen}>
<h1>Hallo!</h1>
<button onClick={() => setState({isOpen: false})}>Close</button>
</Modal>
</div>
```

If you want to set the default state you can do something like that:

initialState = {count: 1};
<button onClick={() => setState({count: state.count+1})}>{state.count}</button>
```jsx
initialState = {count: 1};
<button onClick={() => setState({count: state.count+1})}>{state.count}</button>
```
4 changes: 3 additions & 1 deletion examples/preact/src/components/Placeholder/Readme.md
@@ -1 +1,3 @@
<Placeholder type="beard"/>
```jsx
<Placeholder type="beard"/>
```
6 changes: 4 additions & 2 deletions examples/preact/src/components/RandomButton/Readme.md
@@ -1,4 +1,6 @@
You can `require` external files in your examples:

const names = require('dog-names').all;
<RandomButton variants={names}/>
```jsx
const names = require('dog-names').all;
<RandomButton variants={names}/>
```
4 changes: 3 additions & 1 deletion examples/preact/src/components/WrappedButton/Readme.md
@@ -1,3 +1,5 @@
Enhanced/Decorated components work as well:

<WrappedButton>I'm a wrapped button</WrappedButton>
```jsx
<WrappedButton>I'm a wrapped button</WrappedButton>
```
4 changes: 3 additions & 1 deletion examples/sections/src/components/Label/Readme.md
@@ -1,3 +1,5 @@
Should use the `fantasy` font inherited from `body`:

<Label />
```jsx
<Label />
```
4 changes: 3 additions & 1 deletion examples/sections/src/components/Placeholder/Example.md
@@ -1,3 +1,5 @@
Extra example file linked via `@example` doclet:

<Placeholder type="bear"/>
```jsx
<Placeholder type="bear"/>
```
4 changes: 3 additions & 1 deletion examples/sections/src/components/Placeholder/_Readme.md
@@ -1 +1,3 @@
<Placeholder type="beard"/>
```jsx
<Placeholder type="beard"/>
```
4 changes: 3 additions & 1 deletion examples/webpack/src/components/Placeholder.md
@@ -1 +1,3 @@
<Placeholder type="beard"/>
```jsx
<Placeholder type="beard"/>
```
6 changes: 4 additions & 2 deletions examples/webpack/src/components/RandomButton.md
@@ -1,4 +1,6 @@
You can `require` external files in your examples:

const names = require('dog-names').all;
<RandomButton variants={names}/>
```jsx
const names = require('dog-names').all;
<RandomButton variants={names}/>
```

0 comments on commit 88724cd

Please sign in to comment.