Markdown ファイルを数秒で HTML や PDF に変換

Markdown は、私のような Web コンテンツ制作者が、Web 向けの文章を手軽に書くのに役立ちます。人間にも読みやすい最小限の書式で、コンピューターは HTML と CSS を使って見栄えよく表示できます。Markdown はプラットフォームに依存せず、構文はわずか5 分で学べます。もっと優れた形式があるという意見もありますが、ブログやドキュメントを書く開発者の間で、Markdown が共通言語になっていることは間違いありません。Reddit、Gmail、GitHub など、日常的に使う多くの Web アプリケーションでも使われています。まだ Markdown に慣れていなくても、オンラインには多くの資料があります。私も使い始めた頃は、このチートシートを手元に置いていました。

/document/convert Robot を前回紹介した 2019 年末の時点では、この Robot はまだ初期段階で、SRT と VTT の相互変換しかできませんでした。その後、Robot は多くの形式に対応するようになりました。
今回、/document/convert Robot が Markdown にも対応したことをお知らせします!Markdown ファイルから Web ページや PDF まで、自動で変換できるようになりました。請求書、契約書、受注書を Markdown ですばやく作成し、/document/convert Robot に渡せば、PDF にレンダリングして S3 バケットに保存できます。あるいは、ドキュメントを PDF で納品するよう求める企業と取引していませんか?CI に Transloadit を組み込めば、引き続き Markdown で執筆できます 😄
Markdown から HTML や PDF に変換する方法
/document/convert Robot に新しく追加されたパラメーターのひとつが markdown_format です。Markdown には微妙に仕様が異なる派生形式があるため、このパラメーターが必要になります。Transloadit では現在、値として
"commonmark" と "gfm"(GitHub Flavored Markdown)をサポートしています。
前述のとおり、この新しいパラメーターと既存の format パラメーターを組み合わせると、Markdown の入力ファイルを "html" または
"pdf" に変換できます。
この新機能の使い方を説明するため、以下のスクリプトを用意しました。
実行前に、S3 セットアップガイドに従って、名前付きの Amazon S3 用 Template 認証情報を作成してください。YOUR_AWS_CREDENTIALS を、その保存済みの名前に置き換えてください。S3 Block Public Access を有効にした非公開バケットを使用し、ACL ヘッダーや grant ヘッダーは指定しないでください。acl を bucket-default に設定すると、生成される ACL ヘッダーが省略されますが、バケットが非公開になるわけではありません。
// yarn add transloadit@3
const Transloadit = require('transloadit')
;(async () => {
const transloadit = new Transloadit({
authKey: process.env.TRANSLOADIT_AUTH_KEY,
authSecret: process.env.TRANSLOADIT_AUTH_SECRET,
})
const assemblyStatus = await transloadit.createAssembly({
waitForCompletion: true,
params: {
steps: {
imported: {
robot: '/http/import',
url: 'https://raw.githubusercontent.com/transloadit/uppy/master/README.md',
},
converted: {
use: 'imported',
robot: '/document/convert',
format: 'pdf',
markdown_format: 'gfm',
},
thumbed: {
use: 'converted',
robot: '/document/thumbs',
density: '300',
trim_whitespace: false,
},
exported: {
use: ['converted', 'thumbed'],
robot: '/s3/store',
credentials: 'YOUR_AWS_CREDENTIALS',
acl: 'bucket-default',
},
},
},
})
const pdf = assemblyStatus.results.converted[0]
const thumb = assemblyStatus.results.thumbed[0]
console.log(`Your PDF (${pdf.meta.page_count} pages) is ready at: ${pdf.ssl_url}`)
console.log(`Here's a thumbnail of the first page: ${thumb.ssl_url}`)
})().catch((err) => {
console.log(err)
process.exit(1)
})
これは Node.js のスクリプトですが、このワークフローは Web アプリやモバイルアプリ、バックエンドサービス、コマンドラインユーティリティにも組み込めます。Uppy や Go SDK などの 21 種類の便利な SDK に加え、JSON REST API から直接利用することもできます。
このスクリプトは、いくつかの Step で構成されています。
- /http/import Robot による Markdown ファイルのインポート
- Markdown から PDF への変換
- /document/thumbs Robot による PDF の各ページのプレビューサムネイルの作成
- 生成されたファイルの S3 への保存
スクリプトの実行には、以下のコマンドを使用しました。
# Find your Auth Key and Auth Secret: https://transloadit.com/docs/api/authentication/
export TRANSLOADIT_AUTH_KEY=****
export TRANSLOADIT_AUTH_SECRET=********
node md-to-pdf.js
スクリプトは PDF とサムネイルの URL を出力します。URL が返されても、非公開オブジェクトへの公開読み取りアクセスが許可されるわけではありません。取得するには、別途読み取り権限が必要です。以下は、Markdown をレンダリングしたサムネイルの例です。

PDF が GitHub の Markdown スタイルでレンダリングされていることがわかります。これらのテーマは Markdown 自体ではなく、Markdown レンダラーの機能です。レンダリングのテーマを指定するには、markdown_theme パラメーターを使用してください。現在サポートしている値は、"github"(デフォルト)と
"bare" の 2 種類です。
おわりに
今回は以上です!機能が拡充された /document/convert Robot を、ぜひ Transloadit のワークフローに取り入れてみてください。ご意見があれば、いつものように Twitter でお寄せください。Transloadit の無料 Community Plan には、月あたり 5 GB の十分なトラフィック枠が含まれています。クレジットカードを使わずに、どの開発者でも利用できます。5 GB あれば多くの PDF を処理できますので、ぜひ登録をご検討ください 😄