Skip to content
Permalink
Browse files
Docs: Few small tweaks
  • Loading branch information
sapegin committed Jul 14, 2017
1 parent 5eeffe4 commit c9446836da7c1f039e89da3a02dde66da0433e4b
Showing with 4 additions and 7 deletions.
  1. +2 −4 docs/Configuration.md
  2. +1 −2 docs/Documenting.md
  3. +1 −1 docs/Thirdparties.md
@@ -377,10 +377,8 @@ module.exports = {

Use it like this in you Markdown files:

```md
\`\`\`js { "file": "./some/file.js" }
\`\`\`
```
```js { "file": "./some/file.js" }
```

#### `verbose`

@@ -43,8 +43,7 @@ export default class Button extends React.Component {
## Usage examples and Readme files

Styleguidist will look for any `Readme.md` or `ComponentName.md` files in the component’s folder and display them. Any code block with a language tag of 'js', 'jsx'
or 'javascript' will be rendered as a React component with live editable preview.
Styleguidist will look for any `Readme.md` or `ComponentName.md` files in the component’s folder and display them. Any code block with a language tag of `js`, `jsx` or `javascript` will be rendered as a React component with a live editable preview.

React component example:

@@ -138,7 +138,7 @@ module.exports = {
```

```jsx
// src/MyComponent/index.md
// src/MyComponent/Readme.md
<MyComponent object={sample.object} />
```

0 comments on commit c944683

Please sign in to comment.