Documentation fails to build when using this theme
まだ誰も着手していません。
評価
- 難易度
- 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 にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
documentationjs/documentation-theme-light のほかの issue
-
難易度 3/5 1〜2日 初心者へのやさしさ 35/100
-
難易度 2/5 1〜3時間 初心者へのやさしさ 45/100
documentationjs/documentation-theme-light#5 · リアクション 7 件 ·
-
難易度 1/5 1時間未満 初心者へのやさしさ 20/100
documentationjs/documentation-theme-light#4 · リアクション 1 件 ·
-
難易度 3/5 1〜2日 初心者へのやさしさ 25/100
documentationjs/documentation-theme-light#3 · コメント 3 件 · リアクション 4 件 ·
-
Release?オープン
難易度 4/5 3〜5日 初心者へのやさしさ 15/100
documentationjs/documentation-theme-light#1 · コメント 2 件 · リアクション 3 件 ·
documentationjs/documentation-theme-light の issue をすべて見る
似ている issue
-
Remove unused ts-node dependency対応中かも @marcelofukumoto が今日担当しました。 オープンarea/dashboard kind/tech-debt QA/None
難易度 2/5 1〜3時間 初心者へのやさしさ 83/100
メンテナーはふだん 3 日以内に返信
-
electron tech debt
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
メンテナーはふだん 1 日以内に返信
-
bug
難易度 2/5 1〜3時間 初心者へのやさしさ 66/100
Algorithmiq/monoprop#390 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 76/100
callstack/agent-device#3296 ·
メンテナーはふだん 1 日以内に返信
-
good first issue help wanted
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100