Documentation fails to build when using this theme
还没有人认领这个 Issue。
评估
- 难度
- 3/5
- 预计耗时
- 1-2 天
- 新手友好度
- 38/100
- Issue 类型
- 缺陷
- 描述清晰度
- 基本清楚
- 活跃度
- 停滞
- 技术栈
- css, javascript, node.js
调研方向
从 scripts/build-documentation.js 和 package.json 开始，然后使用 Node 脚本和文档中说明的主题布局重现该故障。在检查项目的源文档路径和生成文档路径时，跟踪与主题相关的 require(...) 调用。文档构建在没有 TypeError 的情况下完成，并在 ./docs 中生成输出，即表示完成。
由索引模型根据 Issue 内容生成。
描述
I pulled down this project as a zip and placed it at the root of my project. Then, based on what I could piece together from the documentation and reading between the lines, I have tried using this theme with the following Node script:
#!/usr/bin/node
const documentation = require('documentation');
const streamArray = require('stream-array');
const vfs = require('vinyl-fs');
documentation.build(['src/**'], {})
.then(res => documentation.formats.html(res, { theme: 'documentation-theme-light-master' }))
.then(output => streamArray(output).pipe(vfs.dest('./docs')));
The relevant file structure is as follows:
node_modules/..
src/..
scripts/build-documentation.js (the above script)
documentation-theme-light-master/..
package.json
When I run documentation in this project, I receive the following error:
(node:18329) UnhandledPromiseRejectionWarning: Unhandled promise rejection (rejection id: 3): TypeError: require(...) is not a function
(node:18329) [DEP0018] DeprecationWarning: Unhandled promise rejections are deprecated. In the future, promise rejections that are not handled will terminate the Node.js process with a non-zero exit code.
The result is that the documentation fails to build and there is no output.
- 主要语言
- CSS
- 星标
- 31
- 派生
- 1
- PR 合并指标
- 30 天内没有已合并 PR
环境准备
这个项目没有提供开发容器、Dockerfile 或贡献指南，环境需要你自己搭建：先看它的 README，通用步骤见我们的新手贡献指南。
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
documentationjs/documentation-theme-light 的其他 Issue
-
难度 3/5 1-2 天 新手友好度 35/100
-
难度 2/5 1-3 小时 新手友好度 45/100
documentationjs/documentation-theme-light#5 · 7 个 reaction ·
-
难度 1/5 1 小时以内 新手友好度 20/100
documentationjs/documentation-theme-light#4 · 1 个 reaction ·
-
难度 3/5 1-2 天 新手友好度 25/100
documentationjs/documentation-theme-light#3 · 3 条评论 · 4 个 reaction ·
-
Release?未关闭
难度 4/5 3-5 天 新手友好度 15/100
documentationjs/documentation-theme-light#1 · 2 条评论 · 3 个 reaction ·
查看 documentationjs/documentation-theme-light 的全部 Issue
相似的 Issue
-
难度 2/5 1-3 小时 新手友好度 78/100
lightpanda-io/browser#3852 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 68/100
-
SDK package doubled in size since 2.81.0 because UMD source maps are published可能已有人在做 关联的 PR 仍在进行中或已合并。 未关闭bug
难度 2/5 1-3 小时 新手友好度 65/100
hiero-ledger/hiero-sdk-js#4476 ·
维护者通常 1 天内回复
-
难度 1/5 1-3 小时 新手友好度 85/100
pytest-dev/pluggy#757 ·
维护者通常 1 天内回复
-
status: team-only type: dependency-upgrade
难度 2/5 1-3 小时 新手友好度 66/100
spring-projects/spring-boot#52098 ·
维护者通常 1 天内回复