サイトのチェック

サイトのチェック

check コマンドは、ビルドの前にドキュメントソースのよくある問題を検証します。

docs-gen check my-docs

docs-gen check my-docs

チェック内容

壊れた内部リンク

すべての Markdown リンクと画像参照をソースページディレクトリに対して解決します。ターゲットファイルが存在しないリンクはエラーとして報告されます。

• ../sibling/ のような相対リンクはページのディレクトリから解決されます
• ディレクトリリンク（/ で終わるもの）は内部に index.md があることを期待します
• 外部リンク（https://, mailto: など）はスキップされます
• アンカーのみのリンク（#section）はスキップされます

重複した order 値

各セクション（サブディレクトリ）内で、インデックス以外のページの order フロントマター値をチェックします。同じ order を持つページが2つ以上あると警告が出ます。サイドバーの順序があいまいになるのを防ぐためです。

未設定の order

セクション内のページで order を設定していない（デフォルトの 0 になる）場合、警告が出ます。明示的な順序指定がほぼ常に意図されているためです。

参照されていないページ

他のどのページの Markdown コンテンツからもリンクされていないページには警告が出ます。目次や「次へ」フッターにリンクを入れ忘れている場合が多いです。

これらのページはサイドバーナビゲーションからはアクセスできます。インデックスページ（index.md）はこのチェックから除外されます。

終了コード

出力例

[warn]  [en] guide/: duplicate order 3 in: guide/02-foo.md, guide/03-bar.md
[error] [en] guide/02-foo.md: broken link target: ../nonexistent/
[warn]  [en] guide/04-baz.md: order is not set (defaults to 0)
[warn]  [en] guide/05-orphan.md: page is not referenced by any link

1 error(s), 3 warning(s) found.

[warn]  [en] guide/: duplicate order 3 in: guide/02-foo.md, guide/03-bar.md
[error] [en] guide/02-foo.md: broken link target: ../nonexistent/
[warn]  [en] guide/04-baz.md: order is not set (defaults to 0)
[warn]  [en] guide/05-orphan.md: page is not referenced by any link

1 error(s), 3 warning(s) found.

次へ: デプロイ