Security News
ESLint is Now Language-Agnostic: Linting JSON, Markdown, and Beyond
ESLint has added JSON and Markdown linting support with new officially-supported plugins, expanding its versatility beyond JavaScript.
@storybook/addon-notes
Advanced tools
Storybook Addon Notes allows you to write notes (text or HTML) for your stories in Storybook.
NOTE: Documentation on next
branch is for alpha version, stable release is on master
yarn add -D @storybook/addon-notes
within .storybook/main.js
:
module.exports = {
addons: ['@storybook/addon-notes/register']
}
Alternatively register the notes addon into a panel. Choose only one, not both.
module.exports = {
addons: ['@storybook/addon-notes/register-panel']
}
Now, you can use the notes
parameter to add a note to each story.
import Component from './Component';
export default {
title: 'Component',
parameters: {
notes: 'some documentation here',
},
};
Using Markdown in your notes is supported, Storybook will load Markdown as raw by default.
import Component from './Component';
import markdown from './someMarkdownText.md';
export default {
title: 'Component',
};
export const withMarkdown = () => <Component />;
withmarkdown.story = {
parameters: {
notes: { markdown },
}
};
When using Markdown, you can also embed gifs from Giphy into your Markdown. Currently, the value cheese
of the query prop is used to search and return the first result returned by Giphy.
# Title
<Giphy query='cheese' />
If you need to display different notes for different consumers of your storybook (e.g design, developers), you can configure multiple notes pages. The following will render a tab with unique notes for both Introduction
and Design
.
import { storiesOf } from '@storybook/react';
import Component from './Component';
import intro from './intro.md';
import design from './design.md';
export default {
title: 'Component',
parameters: {
notes: { Introduction: intro, 'Design Notes': design },
},
};
FAQs
Write notes for your Storybook stories.
The npm package @storybook/addon-notes receives a total of 43,351 weekly downloads. As such, @storybook/addon-notes popularity was classified as popular.
We found that @storybook/addon-notes demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 18 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
ESLint has added JSON and Markdown linting support with new officially-supported plugins, expanding its versatility beyond JavaScript.
Security News
Members Hub is conducting large-scale campaigns to artificially boost Discord server metrics, undermining community trust and platform integrity.
Security News
NIST has failed to meet its self-imposed deadline of clearing the NVD's backlog by the end of the fiscal year. Meanwhile, CVE's awaiting analysis have increased by 33% since June.