Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tuchk4/storybook-readme
React Storybook addon to render README files in github style
https://github.com/tuchk4/storybook-readme
react react-storybook react-storybook-addons readme storybook
Last synced: 11 days ago
JSON representation
React Storybook addon to render README files in github style
- Host: GitHub
- URL: https://github.com/tuchk4/storybook-readme
- Owner: tuchk4
- License: mit
- Created: 2016-10-13T20:01:09.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2022-12-13T13:30:48.000Z (over 1 year ago)
- Last Synced: 2024-06-13T01:05:50.635Z (15 days ago)
- Topics: react, react-storybook, react-storybook-addons, readme, storybook
- Language: JavaScript
- Size: 5.58 MB
- Stars: 544
- Watchers: 11
- Forks: 254
- Open Issues: 95
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Lists
- awesome-stars - tuchk4/storybook-readme - React Storybook addon to render README files in github style (JavaScript)
- awesome-designops - Readme addon - render README files in storybook. (Design System Tools / Components)
- awesome-test - Readme
README
# Storybook README addon
NOTE: This README is only for version `^5.0.0`. For older versions [README_V4.md](./README_V4.md)
All previous api should work correctly at `^5.0.0` and above. **But vue users will need to change their import path, as vue commands have been moved to their own folder.**
---
This addon is compatible with:
- [React Storybook](https://storybook.js.org/docs/guides/guide-react/) ([React example storybook](packages/example-react))
- [Vue Storybook](https://storybook.js.org/docs/guides/guide-vue/) ([Vue example storybook](packages/example-vue))
- Particularly [HTML Storybook](https://storybook.js.org/docs/guides/guide-html/)
[Live demo](https://tuchk4.github.io/storybook-readme)
Features:
- Automatically generate props table (only for React)
- 100% markdown support
- Code highlighting
- Possible to add docs to addons panel or around the story
- Accept multiple README (useful for [hoc component](https://medium.com/@franleplant/react-higher-order-components-in-depth-cf9032ee6c3e) - add component's and original component's README)
- Looks like Github's README
- Supports `` tags for vue components ([example-vue/components/MyButton/MyButton.vue](https://github.com/tuchk4/storybook-readme/blob/master/packages/example-vue/components/MyButton/MyButton.vue)).
Also it very useful because most projects and components already have _README.md_ files. Now it is easy to add them into your Storybook.
Stories will be added with _.addWithInfo_ method if [Storybook Info Addon](https://github.com/storybooks/storybook/tree/master/addons/info) is installed.
## Install
`npm install --save-dev storybook-readme`
or
`yarn add --dev storybook-readme`
#### Webpack Configuration for React Storybook
Nothing to do :)
But if you are using Typescript with React you need to add [markdown-loader](https://www.npmjs.com/package/markdown-loader) in your webpack config
```js
{
test: /\.md$/,
use: [
{
loader: 'markdown-loader',
}
]
}
```
#### Webpack Configuration for Vue Storybook
Only for [Single File Components](https://vuejs.org/v2/guide/single-file-components.html) with `` tag used for documentation.
```js
module.exports = storybookBaseConfig => {
storybookBaseConfig.module.rules.push({
resourceQuery: /blockType=docs/,
use: ['storybook-readme/vue/docs-loader', 'html-loader', 'markdown-loader'],
});
};
```
Define `` tag inside vue module:
```vue
Docs inside vue module
```
Use it to define docs at story:
```js
import MyButton from '../components/MyButton/MyButton.vue';
storiesOf('Vue ', module).addParameters({
readme: {
content: MyButton.__docs,
},
});
```
## Setup
#### Register addon at _.storybook/addons.js_
```js
import 'storybook-readme/register';
```
NOTE: It is possible to set addon's panel title
```js
import registerWithPanelTitle from 'storybook-readme/registerWithPanelTitle';
registerWithPanelTitle('Docs');
```
#### Add decorator at _.storybook/config.js_
```js
import { addDecorator, configure } from '@storybook/react';
import { addReadme } from 'storybook-readme';
// for Vue storybook
import { addReadme } from 'storybook-readme/vue'; // <---- vue subpackage
// for HTML storybook
import { addReadme } from 'storybook-readme/html'; // <---- html subpackage
addDecorator(addReadme);
function loadStories() {
require('../stories/index.js');
}
configure(loadStories, module);
```
> NOTE: for html storybook only sidebar docs are available.
## Usage
Hope it is very simple.
```js
import React from 'react';
import { storiesOf } from '@storybook/react';
import Button from '../components/Button';
import ButtonReadme from '../components/Button/README.md';
storiesOf('Buttons', module)
.addDecorator(withKnobs)
.addParameters({
readme: {
// Show readme before story
content: ButtonReadme,
// Show readme at the addons panel
sidebar: ButtonReadme,
},
})
.add('Button', () => );
```
It is possible to override docs for story
```js
import React from 'react';
import { storiesOf } from '@storybook/react';
import Button from '../components/Button';
import ButtonReadme from '../components/Button/README.md';
storiesOf('Buttons', module)
.addDecorator(withKnobs)
.addParameters({
readme: {
content: ButtonReadme,
sidebar: ButtonReadme,
},
})
.add('Button', () => )
.add('Button', () => )
.add('Button', () => , {
readme: {
// override docs
content: CustomButtonReadme,
sidebar: CustomButtonReadme,
},
});
```
## Full list of options
Will be applied for series of stories.
```js
.addParameters({
readme: {
/**
* Accepts string (markdown) or array of strings
* string | Array
*/
content: Readme,
/**
* Accepts string (markdown) or array of strings
* string | Array
*/
sidebar: Readme,
/**
* Enable / disable code highlighting for sidebar. true by default
*/
highlightSidebar: true,
/**
* Enable / disable code highlighting for content. true by default
*/
highlightContent: true,
/**
* Override theme values
*
* All theme values https://github.com/tuchk4/storybook-readme/blob/master/packages/storybook-readme/src/styles/githubMarkdownCss.js#L436
*/
theme: {},
/**
* Prism code theme
* Full list of theme https://github.com/PrismJS/prism-themes
* To be used with storybook-readme, naming of the code theme should be used in one of these styles. https://github.com/tuchk4/storybook-readme/tree/master/packages/storybook-readme/src/styles/prismCodeThemes
*/
codeTheme: 'github',
/**
* You can include prop tables locally here. See `propTables` example
* for more information
*/
includePropTables: [YourImportedReactComponent],
/**
* Wrapper for story. Usually used to set some styles
* NOTE: will be applied only for content docs (docs around the story)
*
* React: React.ReactNode
* Vue: Vue component
*/
StoryPreview: ({ children}) =>
{children}
/**
* Wrapper for header docs. Usually used to set some styles
* NOTE: will be applied only for content docs (docs around the story)
*
* React: React.ReactNode
* Vue: Vue component
*/
HeaderPreview: ({ children}) =>
{children}
/**
* Wrapper for footer docs. Usually used to set some styles
* NOTE: will be applied only for content docs (docs around the story)
*
* React: React.ReactNode
* Vue: Vue component
*/
FooterPreview: ({ children}) =>
{children}
/**
* Wrapper for content and sidebar docs. Usually used to set some styles
* NOTE: will be applied only for content docs (docs around the story)
*
* React: React.ReactNode
* Vue: Vue component
*/
DocPreview: ({ children}) =>
{children}
},
})
```
## Global configuration
Will be applied for all stories.
NOTE: that `global configuration` is applied only for content docs (docs around the story).
```js
import { addParameters } from '@storybook/react'; // or @storybook/vue for vuejs
import { configureReadme } from 'storybook-readme';
configureReadme({
/**
* Wrapper for story. Usually used to set some styles
* React: React.ReactNode
* Vue: Vue component
*/
StoryPreview: ({ children }) =>
{children},
/**
* Wrapper for content and sidebar docs. Usually used to set some styles
* React: React.ReactNode
* Vue: Vue component
*/
DocPreview: ({ children }) => (
{children}
),
/**
* Wrapper for header docs. Usually used to set some styles
* React: React.ReactNode
* Vue: Vue component
*/
HeaderPreview: ({ children }) => (
{children}
),
/**
* Wrapper for footer docs. Usually used to set some styles
* React: React.ReactNode
* Vue: Vue component
*/
FooterPreview: ({ children }) =>
{children},
/**
* Header docs in markdown format
*/
header: '',
/**
* Footer docs in markdown format
*/
footer: '',
});
addParameters({
readme: {
// You can set a code theme globally.
codeTheme: 'github',
// You can exclude prop tables globally here. See `propTables` example
// for more information
excludePropTables: [YourImportedReactComponent],
},
});
```
## Readme placeholders
- `` placeholder for story
- `` placeholder for story source
- `` placeholder for story source
- `` placeholder for props table. There are some issue with props parsing. Clarification [issue#137](https://github.com/tuchk4/storybook-readme/issues/137#issuecomment-481307652)
- ``, `` content enclosed by the tags won't be shown in stories
```md
Button variants could be imported separately.
\`\`\`js import { OutlinedButton, ContainedButton, TextButton } from 'Button'; \`\`\`
Example:
content here won't be shown in stories
Some docs after story
```
## Emoji
Use shortcodes between colon to insert emoji into the docs. For example
Here is rocket :rocket:
Here is rocket :rocket:
List of all shortcodes could be found at [Emojipedia](https://emojipedia.org) or at [Gist/rxaviers](https://gist.github.com/rxaviers/7360908)
- :rocket:
- :grinning:
- :monkey:
Feel free to suggest new features or report bugs :)
## Api from v4.
Full docs for previous api are at [README_V4.md](./README_V4.md)
TL;DR:
> Accepts README or array of README in markdown format. Multiple README is useful when you develop higher order components and want to add multiple READMEs along with the original component docs.
#### withReadme
Renders README at the addons panel.
```js
import { withReadme } from 'storybook-readme';
import withReadme from 'storybook-readme/with-readme';
// as HigherOrder Component
storiesOf('Button', module).add(
'Default',
withReadme(ButtonReadme, () => ),
);
// as Decorator
storiesOf('Button', module)
.addDecorator(withReadme(ButtonReadme))
.add('Default', () => );
```
#### withDocs
Renders README around the story.
```js
import { withDocs } from 'storybook-readme';
import withDocs from 'storybook-readme/with-docs';
// as HigherOrder Component
storiesOf('Button', module).add(
'Default',
withDocs(ButtonReadme, () => ),
);
// as Decorator
storiesOf('Button', module)
.addDecorator(withDocs(ButtonReadme))
.add('Default', () => );
```
#### doc
Renders README in main frame without story.
```js
import { doc } from 'storybook-readme';
storiesOf('Button', module).add('Default', () => doc(ButtonReadme));
```