我们使用React Styleguidist从项目组件的定义中生成文档。 我们计划通过Github页面提供此类文档。
我们代码的片段:
Button.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>
}
}
Readme.md
[...]
Default Button
```jsx
<div className="styleguide-preview">
<Button />
</div>
```
通过我们设置的NPM脚本运行styleguidist build
命令后,一切正常。我们能够看到Button,其内容又回落到默认的&#34; Button Text&#34;。
如果我们将markdown文件更改为包含<Button> Default </Button>
,则生成的文档的开发版本可以正常工作(其按钮预览显示预期的&#34;默认&#34;。
当我们查看文档的内置版本时,会收到以下错误:ReferenceError: t is not defined
。预览中未显示任何按钮,仅显示错误消息。
生成文档的工作版本的Styleguidist和一个有缺陷的版本之间的唯一区别是(据我们所见)包括或不是Button组件的子项,在markdown自述文件中。
我们在这里做了一些明显的错误吗? 任何帮助或提示表示赞赏:)