Skip to content

Commit c944683

Browse files
committed
Docs: Few small tweaks
1 parent 5eeffe4 commit c944683

File tree

3 files changed

+4
-7
lines changed

3 files changed

+4
-7
lines changed

docs/Configuration.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -377,10 +377,8 @@ module.exports = {
377377

378378
Use it like this in you Markdown files:
379379

380-
```md
381-
\`\`\`js { "file": "./some/file.js" }
382-
\`\`\`
383-
```
380+
```js { "file": "./some/file.js" }
381+
```
384382

385383
#### `verbose`
386384

docs/Documenting.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,8 +43,7 @@ export default class Button extends React.Component {
4343
4444
## Usage examples and Readme files
4545

46-
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'
47-
or 'javascript' will be rendered as a React component with live editable preview.
46+
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.
4847

4948
React component example:
5049

docs/Thirdparties.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -138,7 +138,7 @@ module.exports = {
138138
```
139139

140140
```jsx
141-
// src/MyComponent/index.md
141+
// src/MyComponent/Readme.md
142142
<MyComponent object={sample.object} />
143143
```
144144

0 commit comments

Comments
 (0)