问题标签 [styleguidist]

我正在使用 Styleguidist 神奇地记录我的 React 组件，这很棒。我有几个非组件实用程序库，我使用 JSDoc 编写文档，目前我将它们的文档编译为 markdown（使用jsdoc2md）并告诉 Styleguidist 将该 markdown 文档作为额外文档包含在内。

我添加了一个构建markdown然后运行Styleguidist的npm脚本，这工作正常，但是当我更新一个库时，我必须停止Styleguidist，重新运行脚本，然后再次启动Styleguidist。

监视模式下的 Styleguidist 在检测到文件更改时已经重新构建其文档；是否有某种方法可以配置 Styleguidist 以在每次重新生成之前运行我的降价创建脚本？

我在 Nuxt.js 项目中使用Vue Styleguidist。根据 Styleguidist 和 Webapack 文档，我已经配置了我的styleguide.config.js文件并设置了一些别名：

组件使用这个别名，如下所示：

虽然 Styleguide 无法解析地址。我相信在styleguide.config.js某种程度上被忽略了别名。

有谁知道我应该如何解决这个问题？

我正在通过阅读Fullstack React 书来学习 React 。

我的设置：

按照我运行的styleguidist 安装指南：

这个安装：

• webpack v5.11.0
• react-styleguidist 11.1.5

之间似乎存在某种冲突：

• react-styleguidist和
• 反应简单代码编辑器。

这似乎归结为 React 16 基线上的 react-simple-code-editor 中的对等依赖性，而 react-styleguidist 使用 React 17。

react-simple-code-editor的package.json：

我在这里提出了这个问题，但从未收到回复。

所以我想知道这里是否有人对 React 16 到 17 的增强有更深入的了解可以回答 react-simple-code-editor 中的 react/react-dom 是否可以放宽以使用 16+？如果是这样，语法是什么？

更多关于 Peer Dependencies的信息在这里。

我有一个使用 create react app 创建的项目，并尝试将 styleguidist 集成到其中以生成文档。我可以为默认配置编译它，但我有几个问题。项目结构如下所示。

• 我可以使用它为代码中的组件以外的其他文件夹生成文档吗？在配置中添加路径会给各种文件带来错误。
• 默认配置会生成文档，但是对于 styles.js 文件有很多警告。我尝试在配置文件中为 index.jsx 文件添加部分，但编译失败。我如何实现它？

我正在使用 Styleguidist，但不幸的是它忽略了我的功能组件中的所有内容，例如：

这将只显示第一个注释块，但内部函数将被忽略。基本上函数内的每个注释都被忽略了。知道我想念什么吗？

这让我发疯，但是当我使用 styleguidist server --open 运行 react-styleguidist 时，我只看到一个文件目录，我认为这是我的根目录，而不是我的风格指南。 https://imgur.com/a/9mYliLH

有没有人见过这个？这是我所有的依赖项。