我们使用 React Styleguidist 从项目组件的定义中生成文档。我们计划通过 Github 页面提供此类文档。
我们的代码片段:
按钮.tsx
export default class Button extends PureComponent<Props> {
[...]
render() {
const { href, type, children, theme, size } = this.props
const buttonChildren = children ? children : 'Button Text'
[...]
return <button type="button">{buttonChildren}</button>
}
}
自述文件.md
[...]
Default Button
```jsx
<div className="styleguide-preview">
<Button />
</div>
```
styleguidist build
通过我们设置的 NPM 脚本运行命令后,一切正常。我们能够看到按钮,其内容回退到默认的“按钮文本”。如果我们将 markdown 文件更改为 include <Button> Default </Button>
,则生成文档的开发版本可以正常工作(并且其按钮预览显示预期的“默认值”。当我们检查文档的构建版本时,我们会收到以下错误:ReferenceError: t is not defined
。没有按钮显示在预览中,只有错误消息。
Styleguidist 生成文档的工作版本和错误版本之间的唯一区别是(据我们所见)在 markdown 自述文件中包含或不包含 Button 组件的子组件。
我们在这里做一些公然错误的事情吗?任何帮助或提示表示赞赏:)