AuraDoc
ログイン登録

プロジェクトのREADMEをPDFにする方法

READMEはコードホスティングサービス上では見やすいですが、顧客、レビュー担当者、調達部門は記録用にPDFのプロジェクト文書を求めることがよくあります。このガイドでは、ビルドツールなしでMarkdownファイルを整った文書にします。

PDFはREADMEの構造を保つので、見出し、リスト、表、コードブロックは作者が配置したとおりに表示されます。

手順

  1. READMEファイルを用意する

    リポジトリからREADME.mdをダウンロードするか、エディターから保存します。1 MBまでのファイルに対応しています。

  2. 変換する

    READMEをPDFにを開いてファイルを選びます。設定項目はなく、見出し、リスト、表、コードブロックは自動で整形されます。

  3. 画像を確認する

    Webアドレスを指す画像は読み込まれません。READMEがスクリーンショットに頼っている場合は、後で別ページとして追加します。

  4. 他の文書と結合する

    PDF結合を開き、READMEのPDFに、ライセンス、変更履歴、アーキテクチャ図などのファイルを加えます。

  5. ページに番号を付ける

    PDF にページ番号を追加を開いて形式と位置を選び、レビュー担当者が正確なページを示せるようにします。

このガイドで使うツール

この作業についての質問

複数のMarkdownファイルを変換できますか?
ファイルを1つずつ変換し、その結果をPDF結合で好きな順に結合してください。
バッジや外部画像は表示されますか?
いいえ。インターネット上の画像は読み込まれないため、バッジは表示されません。周囲のテキストは残ります。
READMEはサーバーに送られますか?
変換は安全なサーバーで行われ、PDFの送信直後にファイルは削除されます。結合と番号付けはブラウザー内で動作します。

PDFの用語をやさしく解説

ほかのガイド

ちょっとした修正以上のことが必要ですか?

AuraDocは、OCR、AIによる検索と要約、チーム向けの60以上のPDFツールを備えた文書プラットフォームです。7日間無料でお試しいただけます。

「セキュアサーバー」と表示されたツールは、暗号化された接続でファイルを一度だけ AuraDoc の隔離サーバーに送ります。使い捨てのプロセスで処理し、結果を返した時点で削除します。 公正利用・不正利用防止ポリシー