# @alisowski/storybook-addon-notes 中文文档

规范地址：https://npmcn.com/package/%40alisowski/storybook-addon-notes/

版本：6\.0\.1
npm 元数据更新时间：2022-04-04T13:27:47.480Z
中文译文更新时间：2026-11-06T10:45:19.414Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40alisowski/storybook-addon-notes
原文对照：https://npmcn.com/package/%40alisowski/storybook-addon-notes/?lang=original
项目主页：https://github.com/hipstersmoothie/storybook-addon-notes#readme
源码仓库：https://github.com/hipstersmoothie/storybook-addon-notes

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：15.1 kB，8 个文件
- TypeScript 类型：未声明
- 运行依赖：8 个
- 首次发布：2020-09-04T18:03:37.970Z
- 最新版本发布：2020-09-04T18:03:38.090Z
- 近 30 天下载量：3437（2026-10-06 至 2026-11-04，npm 官方下载统计）
- 已发布版本数：1（近 12 个月 0 个）

## 中文简介

写笔记给你的故事.

## 安装

```sh
npm install @alisowski/storybook-addon-notes
```

也可以使用：`pnpm add @alisowski/storybook-addon-notes`、`yarn add @alisowski/storybook-addon-notes`、`bun add @alisowski/storybook-addon-notes`

## README

# @alisowski/故事书-addon-notes

> 注:故事书对这个插件进行了贬值,赞成 `addon-docs`。 。 。 . 虽然这个插件有用, 但是这个插件可以解决不同的问题 .

Storybook Addon Notes 允许您在 [故事书](https://storybook.js.org/)。 。 。 .

[框架支助](https://github.com/storybookjs/storybook/blob/master/ADDONS_SUPPORT.md)

![Storybook Addon Notes Demo](https://npmcn.com/package/%40alisowski/storybook-addon-notes/docs/demo.png)

## 开始

```sh
yarn add -D @alisowski/storybook-addon-notes
```

在内部 `.storybook/main.js`数字 :

```js
module.exports = {
  addons: ["@alisowski/storybook-addon-notes/register"],
};
```

或者将附加的注录入面板。 只选择一个,而不是两个.

```js
module.exports = {
  addons: ["@alisowski/storybook-addon-notes/register-panel"],
};
```

现在,你可以使用 `notes` 参数可以添加每个故事的注释.

```js
import Component from "./Component";

export default {
  title: "Component",
  parameters: {
    notes: "some documentation here",
  },
};
```

### 升级到 CSF 格式

添加 `notes` 页:1 `parameters` 对象 :

```js
export default {
  parameters: {
    notes: "My notes",
  },
};
```

## 使用马克下

使用您笔记中的 Markdown 支持, Storybook 将默认加载 Markdown 作为原始 .

```jsx
import Component from "./Component";
import markdown from "./someMarkdownText.md";

export default {
  title: "Component",
};

export const withMarkdown = () => <Component />;
withmarkdown.story = {
  parameters: {
    notes: { markdown },
  },
};
```

## 多笔记节

如果您需要为您的故事本的不同消费者(如设计,开发者)显示不同的注释,可以配置多个注释页. 以下将制作一个标签, 上面有两个独有的注释 `Introduction` 财务报告和审定财务报表 `Design`。 。 。 .

```js
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 },
  },
};
```

## 常见问题

### @alisowski/storybook-addon-notes 是什么？

写笔记给你的故事\.

### 如何安装 @alisowski/storybook-addon-notes？

在项目目录运行 npm install @alisowski/storybook-addon-notes，或使用 pnpm add / yarn add / bun add。

### @alisowski/storybook-addon-notes 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/alisowski\_\_storybook-addon-notes 是否存在。

### @alisowski/storybook-addon-notes 可以商用吗？

@alisowski/storybook-addon-notes 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @alisowski/storybook-addon-notes 的下载量有多少？

根据 npm 官方下载统计，@alisowski/storybook-addon-notes 在 2026/10/06 – 2026/11/04 这 30 天内被下载 3,437 次，日均约 115 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @alisowski/storybook-addon-notes 还在维护吗？

最新版本 6\.0\.1 发布于 2020/09/05（6 年前）；至今共发布 1 个版本，其中过去 12 个月发布了 0 个；首次发布于 2020/09/05。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。