MDPress

GitHubのMarkdownをPDFに

README PDF変換、GitHubのどんなプロジェクトにも

READMEはGitHub上で読まれることを前提に書かれていますが、クライアントへの引き継ぎやコンプライアンス資料、課題提出のようにファイルとして扱う必要が出てくることもあります。MDPressは同じGitHub風のMarkdownを読み込むため、タスクリストや表、コードブロックがそのままページ分けされたPDFになり、コードはハイライト表示され、テキストは選択できます。

変換ツールを開く

GitHub READMEのPDF変換を3ステップで。

  1. 01

    元のMarkdownを取得する

    GitHub上でREADME.mdを開き、Rawボタンを押すか、隣にあるコピー用アイコンを使います。リポジトリをクローンしている場合は、すでにディスク上にファイルがあります。

  2. 02

    貼り付けるかアップロードする

    テキストをエディターに貼り付けるか、「Markdownをアップロード」を選んで.mdファイルを開きます。ライブプレビューで全セクションが実際のページとして表示されるので、画像の欠落や長すぎるコード行を書き出す前に確認できます。

  3. 03

    ページを設定してダウンロードする

    テクニカルスタイルはセクションに番号を振り、コードブロックに余裕を持たせるのでドキュメントに向いています。A4またはUS Letterを選び、READMEが長ければ目次を有効にしてダウンロードします。

変換できる小さなREADMEの例。

このようなファイルを貼り付けると、内容がそのままPDFに反映されます。

# tinycache

Node.js向けの、時間指定で失効する小さなインメモリキャッシュです。

## インストール

```bash
npm install tinycache
```

## 使い方

```js
import { createCache } from "tinycache";
const cache = createCache({ ttl: 60_000 });
cache.set("user:1", { name: "Ada" });
```

## ロードマップ

- [x] キーごとの失効
- [ ] サイズ上限

tinycache

Node.js向けの、時間指定で失効する小さなインメモリキャッシュです。

インストール

npm install tinycache

使い方

import { createCache } from "tinycache";
const cache = createCache({ ttl: 60_000 });
cache.set("user:1", { name: "Ada" });

ロードマップ

  • キーごとの失効
  • サイズ上限

READMEをここで変換する理由。

GitHub風のMarkdownを読み込む

タスクリスト、パイプ区切りの表、言語ラベル付きのコードブロック、自動リンク、取り消し線はすべて認識されます。GitHubと同じ書式を扱っているためです。mermaidのフェンスはリポジトリのページと同じように図として描かれます。

紙の上でも読みやすいコード

インストールコマンドや設定例は言語ごとにハイライトされます。ページ幅より長い行はブロック内で折り返されるので、長いコマンドの末尾を推測する必要はありません。

見出しから作られる目次

長いREADMEには見出しによる構成がすでにあります。Contentsツールは見出しの上位3階層を先頭のページに一覧表示し、ページ番号を付けます。Coverツールはプロジェクト名、著者、日付を記載した表紙を追加します。

ヒントと正直な制限。

  • docs/screenshot.pngのような相対パスの画像は読み込まれません。変換ツールはリポジトリを参照できないためです。Imagesツールで画像をアップロードするか、パスを画像の完全なウェブアドレスに置き換えてください。
  • 生のHTMLはテキストとして表示され、描画はされません。中央揃えのロゴやバッジの並び、折りたたみセクションにHTMLを使っているREADMEは多いので、その部分は通常のMarkdownに書き直すか削除してください。
  • CONTRIBUTING.mdのようなリポジトリ内の他ファイルへの相対リンクは、PDFの中では行き先がありません。書き出す前にGitHubの完全なアドレスに変更してください。

README PDF変換に関するよくある質問。

GitHubのリンクを貼り付けてREADMEを直接変換できますか。
いいえ。MDPressはリポジトリを取得しません。GitHub上でREADMEを開いてRawを押し、テキストをコピーして貼り付けるか、クローンしたREADME.mdファイルをアップロードしてください。数秒で済み、テキストを自分で用意するのでプライベートリポジトリでも使えます。
README PDFから画像が消えてしまうのはなぜですか。
READMEが相対パスで画像を指定している可能性が高く、これはリポジトリ内でしか解決できません。各画像をImagesツールから追加して文書に埋め込むか、ウェブ上の絶対アドレスにリンクしてください。埋め込んだ画像は4MBの上限に含まれます。
READMEのバッジやHTMLブロックは動きますか。
完全なウェブアドレスを持つMarkdownの画像記法で書かれたバッジは、他の画像と同じように読み込まれます。HTMLタグで書かれた部分はそのままの文字として表示されるので、中央揃えのヘッダーブロックやdetailsセクションはまずMarkdownに変換する必要があります。

READMEを送れるファイルにしましょう。

元のMarkdownを貼り付けるかREADME.mdをアップロードし、プレビューを確認してダウンロードします。1日4件までのPDFはアカウント不要です。

変換ツールを開く