Shopifyのブログ記事にコードのシンタックスハイライト機能を付ける Tsun Inc.

Shopifyのブログ記事にコードのシンタックスハイライト機能を付ける

Tsun Inc.でCTOをしている小笠原です！
最近はShopifyのアプリやテーマの開発を行っています。
このブログではShopify開発に役立つ情報を共有していきます。
Shopifyエンジニアの方の参考になれば嬉しいです！

なぜ作ろうと思ったのか

テック系のブログ記事を書くときにコードを載せることが多くなりますが、Shopifyのブログ記事そのままだとコードが読みづらいため。

作成したもの

Dawnをベースにブログ記事にコードのシンタックスハイライト機能を付けました。
シンタックスハイライト機能を実現するライブラリはPrism、highlight.jsなどがありますが、今回はPrismを採用しました。

以下で、DawnテーマにPrismを使ったシンタックスハイライト機能の付け方を説明します！
作成物を直接見たい方はTsun Inc.のリポジトリを参照してみてください。

前提条件

対象読者

  • Shopifyのテーマ変更ができる
  • HTML、CSS、JavaScript、Liquidに関する簡単な知識がある

準備するもの

  • Dawnテーマ (v5.0.0で動作確認しましたが、以前のバージョンでも問題ないはずです)
  • ブログ記事

実装

※ 今回の実装方法ではShopifyのテーマのコードを直接編集する方法をとるため、必ず事前にバックアップをしておいてください。

今回の実装では

  • PrismのJS、CSSファイルの作成
  • ブログ記事用のLiquidファイルでPrismを読み込む

の2つの工程を行います。

PrismのJS、CSSファイルの作成

単にシンタックスハイライト機能を試してみたい方はこの工程はスキップしても問題ありません。

サンプルとして用意したTsun Inc.のGitHubリポジトリから

をダウンロードしてください。

ご自分でPrismのファイルを用意したい方は下記を実行してください。

  1. https://prismjs.com/download.html に行き、必要な言語とプラグインにチェックを入れる

    Prismは必要な機能のみを含んだJS、CSSファイルを生成することで軽量化を実現しています。
    僕は今後記事を書く際に必要になりそうな言語とLine Highlight、Line Numbers、Unescaped Markup、Toolbar、Copy to Clipboard Button、Diff Highlightプラグインにチェックを付けました。

  2. 下部のDOWNLOAD JSボタン、DOWNLOAD CSSボタンを押して、prism.jsとprism.cssをダウンロードする

ブログ記事用のLiquidファイルでPrismを読み込む

手元にprism.jsとprism.cssが用意できたと思いますので、Shopifyテーマに組み込みます。

  1. Shopifyの管理画面から オンラインストア > テーマ を選択
  2. アクション > コードを編集 を選択
  3. Assets > 新しいassetを追加を選択
  4. ファイルをアップロード からprism.jsを選択してアップロード
  5. 同様にprism.cssもアップロード
  6. Sectionsのmain-article.liquidを開く
  7. 下記のようにコードを編集
  8. 保存する を選択して保存

ここまでできたら、ブログ記事内でコード用のタグを書けばPrismが自動でシンタックスハイライトを付けてくれます！
タグの書き方はhttps://prismjs.com/index.html#basic-usageを参考にしてください。

Scriptタグを使う場合の注意点

spanタグやscriptタグなどのHTMLのタグを含むコードの場合、ブログ記事を保存する際にShopify側でエスケープされてしまうので、エスケープされないようにする必要があるので注意してください。

<pre><code class="language-css"><!--
<script src="{{ 'table-of-contents.js' | asset_url }}" defer="defer" />
--></code></pre>

のように記述すればOKです。

まとめ

今回はShopifyのブログ記事にコードのシンタックスハイライト機能を付ける方法をご紹介しました。
Prismは軽量でありつつ多機能なので、ご自身にあった表示方法にカスタマイズをいろいろしてみてください！

Tsun Inc.ではShopifyテーマのカスタマイズにも対応してます。
もし、Shopifyテーマのカスタマイズをしたい方は、Tsun Inc.へお問い合わせください。

まだShopifyのブログ機能を利用していない方は、下記の記事でShopifyのブログ機能について解説していますので参考にしてみてください。

Shopifyのブログ機能をフル活用しよう｜機能や拡張アプリを紹介

ブログに戻る

Shopify Apps

  • RuffRuff 予約販売｜Shopifyアプリ

    RuffRuff 予約販売

    Shopifyストアに予約販売機能を簡単に導入できるShopifyアプリ

    詳しくみる 
  • RuffRuff 目次作成｜Shopifyアプリ

    RuffRuff 目次作成

    Shopifyのコンテンツに自動で目次を表示するShopifyアプリ

    詳しくみる 
  • RuffRuff タグ一覧｜Shopifyアプリ

    RuffRuff タグ一覧

    Shopifyストアにタグ一覧を自動で表示するShopifyアプリ

    詳しくみる 
  • RuffRuff 著者情報｜Shopifyアプリ

    RuffRuff 著者情報

    Shopifyストアに著者プロフィールを簡単に表示できるShopifyアプリ

    詳しくみる 
1 4

Blogs

すべてを表示する
1 4
すべてを表示する

Tech Blogs

すべてを表示する
  • Shopify Vite Plugin でテーマ拡張機能の開発体験を改善する

    Shopify Vite Plugin でテーマ拡張機能の開発体験を改善する

    小笠原 京平

    今回は Barrel が提供する Shopify Vite Plugin を導入して、テーマ拡張機能の開発体験を改善する方法をご紹介します。 対象読者 テーマ拡張機能の開発経験がある方 はじめに Shopifyのテーマ拡張機能 (Theme app extensions) はShopify アプリ開発において、ストアフロントに機能を追加するための機能です。 Liquid、JavaScript、CSSなどを使って開発することができますが、通常のアプリ開発と比較すると、ローカルでの開発体験はそれほどよくありません。 そこで、今回は Shopify Vite Plugin を導入して、開発体験を改善していきます。 Shopify Vite Plugin とは Barrel が提供する Vite用プラグインです。ViteをShopify テーマ開発に組み込んで開発体験を改善することを目的として作られていますが、テーマ拡張機能においてもその恩恵を受けることができます。...

    Shopify Vite Plugin でテーマ拡張機能の開発体験を改善する

    小笠原 京平

    今回は Barrel が提供する Shopify Vite Plugin を導入して、テーマ拡張機能の開発体験を改善する方法をご紹介します。 対象読者 テーマ拡張機能の開発経験がある方 はじめに Shopifyのテーマ拡張機能 (Theme app extensions) はShopify アプリ開発において、ストアフロントに機能を追加するための機能です。 Liquid、JavaScript、CSSなどを使って開発することができますが、通常のアプリ開発と比較すると、ローカルでの開発体験はそれほどよくありません。 そこで、今回は Shopify Vite Plugin を導入して、開発体験を改善していきます。 Shopify Vite Plugin とは Barrel が提供する Vite用プラグインです。ViteをShopify テーマ開発に組み込んで開発体験を改善することを目的として作られていますが、テーマ拡張機能においてもその恩恵を受けることができます。...

  • Shopify Admin API GraphiQLとは？ 使い方やメリット・デメリットを解説

    Shopify Admin API GraphiQLとは？ 使い方やメリット・デメリットを解説します

    小笠原 京平

    ShopifyのAdmin APIにはGraphQLを用いたAPIがあります。手軽に試す方法としてGraphiQL (GraphQLではなくGraphiQLなのに注意) というIDEがありますので、今回はShopify GraphiQLの使い方やメリット・デメリットを解説します。 GraphiQLとは GraphQL公式が運営しているオープンソースプロジェクトです。GraphQLをブラウザ上でインタラクティブに操作・実行することができます。 グラフィカル (/ˈɡrafək(ə)l/) と発音します。(graphicalと同じ発音) GraphQLとは GraphQLはAPIのためのクエリ言語であり、既存のデータでクエリを実行するためのランタイムです。 GraphQLはAPI内のデータの完全で理解しやすい説明を提供し、クライアントに必要なものだけを要求する力を与え、APIを長期的に進化させることを容易にし、強力な開発者ツールを可能にします。 引用: GraphQL | A query language for your API Shopify GraphiQLの使い方 Shopify GraphiQLは各ストアにアプリをインストールするだけで使えますが、Shopify Devサイト上でデモを触れるので、まずは触ってみましょう！ https://shopify.dev/docs/apps/tools/graphiql-admin-api Workshopをやってみよう！ Shopifyが作成した「Learn...

    Shopify Admin API GraphiQLとは？ 使い方やメリット・デメリットを解説します

    小笠原 京平

    ShopifyのAdmin APIにはGraphQLを用いたAPIがあります。手軽に試す方法としてGraphiQL (GraphQLではなくGraphiQLなのに注意) というIDEがありますので、今回はShopify GraphiQLの使い方やメリット・デメリットを解説します。 GraphiQLとは GraphQL公式が運営しているオープンソースプロジェクトです。GraphQLをブラウザ上でインタラクティブに操作・実行することができます。 グラフィカル (/ˈɡrafək(ə)l/) と発音します。(graphicalと同じ発音) GraphQLとは GraphQLはAPIのためのクエリ言語であり、既存のデータでクエリを実行するためのランタイムです。 GraphQLはAPI内のデータの完全で理解しやすい説明を提供し、クライアントに必要なものだけを要求する力を与え、APIを長期的に進化させることを容易にし、強力な開発者ツールを可能にします。 引用: GraphQL | A query language for your API Shopify GraphiQLの使い方 Shopify GraphiQLは各ストアにアプリをインストールするだけで使えますが、Shopify Devサイト上でデモを触れるので、まずは触ってみましょう！ https://shopify.dev/docs/apps/tools/graphiql-admin-api Workshopをやってみよう！ Shopifyが作成した「Learn...

  • ブログ記事 Shopifyの必須Webhooks (Mandatory Webhooks)とは？ GDPRや対応例など

    Shopifyの必須Webhooks (Mandatory Webhooks)とは？ GDPR...

    小笠原 京平

    今回はShopifyアプリ開発を始めたときに詰まるポイントの1つ「必須Webhooks」について解説します。実装をしていなかったり、実装が不十分なためにレビューが通らなかった経験をされた方は多いんじゃないでしょうか？レビューで詰まらないためにも、ぜひご確認ください！ Webhooksとは？ Shopifyの必須Webhooksを説明する前に、Webhooksについて理解しましょう。Webhooksとは、Webアプリケーションと連携するために用いられるイベント通知の仕組みです。Webhooksを使うことで、あるWebアプリケーションで特定のイベントが起きたときに、データを受け取ったり、何かしらの動作をすることが可能になります。 エンジニアにとって身近な例でいうと、GitHubにコードをプッシュしたときに自動でビルドやテストをするときにWebhooksが使われています。 ShopifyのWebhooks そんなWebhooksはShopifyでも使うことができます。Shopifyアプリ開発では、Shopify Admin APIからWebhooksを使うことができます。また、アプリ以外でもShopify管理画面からWebhookを作成することもできます。 ShopifyのWebhooksにはHTTPSのエンドポイントのほか、Amazon EventBridgeやGoogle Cloud Pub/Subといったメッセージングサービスを使うこともできます。購読するイベントやマーチャントによっては瞬間的に大量のWebhooksを処理する必要があるため、スケールさせやすいメッセージングサービスを使ってWebhooksを処理することをおすすめします。 必須Webhooks (Mandatory Webhooks) とは？ 必須Webhooksとは、Shopifyアプリを開発するときに必ず実装しなければならない3つのWebhooksのことです。この3つのWebhooksはGDPRに対応するために必要なWebhooksで、EU加盟国に関わらず、すべてのShopifyアプリはGDPRに準拠しなければなりません。必須Webhooksを実装していない場合、アプリレビューで却下されます。 (3つの必須Webhooks以外のWebhooksは任意で実装すればOKです。) また、必須Webhooksの3つはHTTPSのエンドポイントでのみ作成可能です。上述したEventBridgeやPub/Subを利用することはできません。 GDPRとは？ GDPR（General Data Protection Regulation：一般データ保護規則）は、ヨーロッパ連合（EU）の個人情報保護法規で、2018年5月25日から施行されています。これは、EU全域での個人情報のプライバシーを保護し、データの取り扱い方に関して個々の人々により多くの制御権を付与するためのものです。 GDPRは、EU市民または居住者の個人データを処理する全ての組織に適用されます。これには、EU内外の組織も含まれ、EUの市民や居住者のデータを処理する場合、世界のどこにその組織があろうともGDPRの規定を守る必要があります。 GDPRの主な目的は、個人が自分の個人データをどのように収集、保存、使用されるのかを知り、そしてその制御をする権利を持つべきであるという考え方を強化し、統一化することです。これは、個人情報の透明性、アクセスの権利、修正の権利、忘れられる権利（データ削除の権利）、データ移行の権利など、いくつかの重要な権利を個々の人々に付与します。 参考: ChatGPT 必須Webhooksの対応例 上記で説明したように、必須WebhooksとはGDPRに準拠するためのWebhooksなので、顧客情報、ストア情報をデータベースなどに保存しているかどうかで対応方法が変わります。...

    Shopifyの必須Webhooks (Mandatory Webhooks)とは？ GDPR...

    小笠原 京平

    今回はShopifyアプリ開発を始めたときに詰まるポイントの1つ「必須Webhooks」について解説します。実装をしていなかったり、実装が不十分なためにレビューが通らなかった経験をされた方は多いんじゃないでしょうか？レビューで詰まらないためにも、ぜひご確認ください！ Webhooksとは？ Shopifyの必須Webhooksを説明する前に、Webhooksについて理解しましょう。Webhooksとは、Webアプリケーションと連携するために用いられるイベント通知の仕組みです。Webhooksを使うことで、あるWebアプリケーションで特定のイベントが起きたときに、データを受け取ったり、何かしらの動作をすることが可能になります。 エンジニアにとって身近な例でいうと、GitHubにコードをプッシュしたときに自動でビルドやテストをするときにWebhooksが使われています。 ShopifyのWebhooks そんなWebhooksはShopifyでも使うことができます。Shopifyアプリ開発では、Shopify Admin APIからWebhooksを使うことができます。また、アプリ以外でもShopify管理画面からWebhookを作成することもできます。 ShopifyのWebhooksにはHTTPSのエンドポイントのほか、Amazon EventBridgeやGoogle Cloud Pub/Subといったメッセージングサービスを使うこともできます。購読するイベントやマーチャントによっては瞬間的に大量のWebhooksを処理する必要があるため、スケールさせやすいメッセージングサービスを使ってWebhooksを処理することをおすすめします。 必須Webhooks (Mandatory Webhooks) とは？ 必須Webhooksとは、Shopifyアプリを開発するときに必ず実装しなければならない3つのWebhooksのことです。この3つのWebhooksはGDPRに対応するために必要なWebhooksで、EU加盟国に関わらず、すべてのShopifyアプリはGDPRに準拠しなければなりません。必須Webhooksを実装していない場合、アプリレビューで却下されます。 (3つの必須Webhooks以外のWebhooksは任意で実装すればOKです。) また、必須Webhooksの3つはHTTPSのエンドポイントでのみ作成可能です。上述したEventBridgeやPub/Subを利用することはできません。 GDPRとは？ GDPR（General Data Protection Regulation：一般データ保護規則）は、ヨーロッパ連合（EU）の個人情報保護法規で、2018年5月25日から施行されています。これは、EU全域での個人情報のプライバシーを保護し、データの取り扱い方に関して個々の人々により多くの制御権を付与するためのものです。 GDPRは、EU市民または居住者の個人データを処理する全ての組織に適用されます。これには、EU内外の組織も含まれ、EUの市民や居住者のデータを処理する場合、世界のどこにその組織があろうともGDPRの規定を守る必要があります。 GDPRの主な目的は、個人が自分の個人データをどのように収集、保存、使用されるのかを知り、そしてその制御をする権利を持つべきであるという考え方を強化し、統一化することです。これは、個人情報の透明性、アクセスの権利、修正の権利、忘れられる権利（データ削除の権利）、データ移行の権利など、いくつかの重要な権利を個々の人々に付与します。 参考: ChatGPT 必須Webhooksの対応例 上記で説明したように、必須WebhooksとはGDPRに準拠するためのWebhooksなので、顧客情報、ストア情報をデータベースなどに保存しているかどうかで対応方法が変わります。...

  • Shopifyアプリの課金ってどうやるの？ 課金方法とサブスクリプション設計を解説

    Shopifyアプリの課金ってどうやるの？ 課金方法とサブスクリプション設計を解説

    小笠原 京平

    Shopifyアプリの課金とは？ Shopifyアプリの課金方法は、大きく分けてShopify内で決済する方法とShopify外で決済する方法の2つあります。 Shopify内で決済する場合、Shopifyアプリの料金は、マーチャントからShopifyに支払われ、税金や手数料を除いた料金がShopifyからアプリベンダーに支払われます。 Shopify内で決済する一番のメリットはマーチャントが課金する際にクレジットカード等の入力が不要なため、そのぶんの課金ハードルが低いことです。 デメリットは手数料をShopifyに支払う必要があることですが、現状ではよっぽど稼ぐアプリを作らない限り気にするほどではないので、Shopify内で決済させるのがよいと思います。 Shopify外で決済する場合、アプリベンダーは独自の決済フローを用意する必要があります。 こちらについては今回は触れません。以下はすべてShopify内の課金についての説明になります。 Shopifyアプリの課金の流れ Shopifyアプリで課金するための道具はすべてShopify側が用意してくれています。 したがって、Shopifyアプリは決められたパターンの実装するだけで、簡単に課金が行なえます。 Shopifyアプリの課金はざっくりと以下の流れで行われます。 【アプリ】Shopifyアプリの画面内に配置された課金ボタンをユーザーがクリック 【サーバー】課金の種類(種類については後述します)、課金額、プラン名などを元にShopify GraphQL APIにリクエストを送る 【サーバー】ユーザーに課金してもらうためのURLを含むデータをAPIから受け取り、アプリに渡す 【アプリ】課金用のURLにリダイレクト 4で表示された課金用のページでユーザーが課金を選択したら、課金が行われます。 (もちろん、キャンセルを選択して離脱する可能性もあります) 課金の種類 Shopifyでの課金方法はいくつかあります。 1つ目は定額料金プラン(固定額プラン)です。 定額料金には月払いと年払いのどちらかを選ぶことができます。 2つ目は使用状況に基づくプランで、いわゆる従量課金と呼ばれるプランです。 何の使用状況によって、どのくらいの課金をするかはアプリが決めることができます。 (メール配信をするアプリならメールの配信量、商品販売に関連するアプリなら販売された商品金額など) 3つ目は1と2を組み合わせたプランです。 ここでは定額料金の年払いは選択できませんので、月払い + 従量課金の組み合わせのみになります。...

    Shopifyアプリの課金ってどうやるの？ 課金方法とサブスクリプション設計を解説

    小笠原 京平

    Shopifyアプリの課金とは？ Shopifyアプリの課金方法は、大きく分けてShopify内で決済する方法とShopify外で決済する方法の2つあります。 Shopify内で決済する場合、Shopifyアプリの料金は、マーチャントからShopifyに支払われ、税金や手数料を除いた料金がShopifyからアプリベンダーに支払われます。 Shopify内で決済する一番のメリットはマーチャントが課金する際にクレジットカード等の入力が不要なため、そのぶんの課金ハードルが低いことです。 デメリットは手数料をShopifyに支払う必要があることですが、現状ではよっぽど稼ぐアプリを作らない限り気にするほどではないので、Shopify内で決済させるのがよいと思います。 Shopify外で決済する場合、アプリベンダーは独自の決済フローを用意する必要があります。 こちらについては今回は触れません。以下はすべてShopify内の課金についての説明になります。 Shopifyアプリの課金の流れ Shopifyアプリで課金するための道具はすべてShopify側が用意してくれています。 したがって、Shopifyアプリは決められたパターンの実装するだけで、簡単に課金が行なえます。 Shopifyアプリの課金はざっくりと以下の流れで行われます。 【アプリ】Shopifyアプリの画面内に配置された課金ボタンをユーザーがクリック 【サーバー】課金の種類(種類については後述します)、課金額、プラン名などを元にShopify GraphQL APIにリクエストを送る 【サーバー】ユーザーに課金してもらうためのURLを含むデータをAPIから受け取り、アプリに渡す 【アプリ】課金用のURLにリダイレクト 4で表示された課金用のページでユーザーが課金を選択したら、課金が行われます。 (もちろん、キャンセルを選択して離脱する可能性もあります) 課金の種類 Shopifyでの課金方法はいくつかあります。 1つ目は定額料金プラン(固定額プラン)です。 定額料金には月払いと年払いのどちらかを選ぶことができます。 2つ目は使用状況に基づくプランで、いわゆる従量課金と呼ばれるプランです。 何の使用状況によって、どのくらいの課金をするかはアプリが決めることができます。 (メール配信をするアプリならメールの配信量、商品販売に関連するアプリなら販売された商品金額など) 3つ目は1と2を組み合わせたプランです。 ここでは定額料金の年払いは選択できませんので、月払い + 従量課金の組み合わせのみになります。...

1 4
すべてを表示する

編集プロセス

EコマースやShopifyの初学者にとって、できるだけ “やさしく” “わかりやすく” “正確に” 難しいコマース用語やマーケティング用語、ストア構築から販売までの仕組み・ノウハウを伝えることを心がけて、記事コンテンツを作成しています。

詳しく見る →

掲載情報に関して

掲載している各種情報は、株式会社Tsunが経験および、調査した情報をもとにしています。できるだけ“最新“かつ“正確“な情報の掲載に努めておりますが、内容を完全に保証するものではありません。当サイトによって生じた損害について、株式会社Tsunではその賠償の責任を一切負わないものとします。掲載情報に誤りがある場合には、お手数ですが株式会社Tsunまでご連絡をいただけますようお願いいたします。