DocFx Companion Tools

MarkdownファイルとソースファイルをDocFx Companion ToolsのユーティリティでDocFXドキュメントに変換します。Laurent EllerbachとMartin Tirionによって作成されたこのパッケージには、ドキュメントの準備、整理、チェック、翻訳、変換を行うツールがまとめられており、現在のバージョンは2.0.0です。

DocFxTocGeneratorは、MDファイルを含むフォルダ構造を調べ、ドキュメントナビゲーション用のコンテンツのマッチングテーブルを作成します。 DocLinkChecker は、MD ファイルが参照するリンクと添付ファイルを検証し、準備とレビューの間に壊れたドキュメントの参照を識別するのに役立ちます。

DocLanguageTranslator は、Azure 認知サービスを通じて MD ファイルを自動的に翻訳し、同じドキュメントワークフローに翻訳を追加します。 DocFxOpenApi は、既存の OpenAPI 仕様ファイルを DocFX と互換性のある形式に変換します。そのため、API の説明は生成されたドキュメントに組み込むことができます。

ユーティリティは、Markdownコンテンツを整理する開発者、テクニカルライター、およびドキュメントメンテナーに適し、参照をチェックし、それを翻訳するか、またはDocFXプロジェクトでAPI仕様を接続します。 典型的なワークフローは、フォルダーのレイアウトを使用して、ナビゲーション、リンクと添付ファイルの確認、プロセスの翻訳、最終ドキュメントを生成する前に OpenAPI 素材の変換ができます。 パッケージはWindowsで動き、フリーウェアとして配られます。