Shoeisha Technology Media

CodeZine(コードジン)

特集ページ一覧

Markdownテキストを整形するAngular Markedとコードをハイライト整形するAngular Highlightjs

AngularJSアプリ開発を支援する便利モジュール(11)

  • LINEで送る
  • このエントリーをはてなブックマークに追加
2016/03/24 14:00

 AngularJSは、テンプレートエンジン、データバインディング、ルーティング、DIコンテナーなどなど、Webアプリのフロントエンドを開発するために必要な機能をあまねく揃えたフルスタックのフレームワークです。もっとも、本格的な開発ではそれだけで賄えるわけではなく、要件に応じて、周辺のモジュールと連携するのが一般的です。本連載では、AngularJSで利用できる拡張ライブラリを、具体的な利用例とともに紹介します。

目次

 なお、本連載ではAngularJSそのものに関しては解説しませんので、専門書として『AngularJSアプリケーションプログラミング』、姉妹連載「AngularJSではじめるJavaScriptフレームワーク開発スタイル」などを併せて参照してください。

はじめに

 本連載も早いもので、第11回です。今回は、テキストを整形するためによく利用する、以下のライブラリについて解説します。

  • Angular Marked:Markdown形式のテキストをHTML形式に変換
  • Angular Highlightjs:ソースコードに構文ハイライトを付与

対象読者

  • AngularJSについて基本的な概念を理解している方
  • AngularJSで利用できる拡張モジュールに興味がある方
  • AngularJSアプリでMarkdown形式のテキストを扱いたい方
  • AngularJSアプリでソースコードを見やすく表示したい方

検証環境

 この記事では、以下の環境でサンプルの動作を確認しています。

  • AngularJS 1.5.0(Angular Sanitizeを含む)
  • Angular Marked 1.0.1
  • Angular Highlightjs 0.5.1
  • highlightjs 9.1.0
  • Chrome 49
  • Firefox 44
  • Internet Explorer 11

Markdown形式のテキストをHTML形式に変換する - Angular Marked

 Markdownとは、修飾のある(=画像やリストなどを伴う)テキストを記述するための簡易なマークアップ言語です。マークアップ言語というと、まずHTMLを思い出す人も多いかもしれませんが、HTMLよりも手軽に書けるのが特長です(その分、表現には制約があります)。たとえばはてなブログ、Qiitaなどの投稿に際してもMarkdown形式は利用できますし、GitHubのReadmeにもMarkdown形式は利用されていますので、Markdown形式を日常的に触れているという人も多いかもしれません。本稿では、Markdown形式そのものに関する詳しい解説は割愛しますので、詳しくは「Markdownとは」のようなページを参照してください。

 ここで解説するのは、Markdown形式で書かれたテキストを、ブラウザー上で表示できるよう、HTML形式に変換するAngular Markedです。

Angular Markedで整形されたMarkdown形式のテキスト
Angular Markedで整形されたMarkdown形式のテキスト

 Angular Markedは、Bowerを利用することで、以下のコマンドで実行できます。

> bower install --save angular-marked

 では、具体的なサンプルをみていきましょう。以下は、与えられたMarkdown形式のテキストを整形&表示する例です。元となるテキストは、UI-EventReadme.mdを利用しています。

リスト1 marked.html
<!DOCTYPE html>
<html ng-app="myApp">
<head>
<meta charset="UTF-8" />
<title>AngularJS</title>
<!-- (1)marked.min.js、angular-marked.min.jsをインポート -->
<script src="bower_components/angular/angular.min.js"></script>
<script src="bower_components/marked/marked.min.js"></script>
<script src="bower_components/angular-marked/dist/angular-marked.min.js"></script>
<script src="scripts/marked.js"></script>
</head>
<body ng-controller="MyController">
<!-- (3)markedディレクティブ(属性)を付与&.mdファイルを指定 -->
<div marked ng-include="'README.md'"></div>
</body>
</html>
リスト2 marked.js
// (2)hc.markedモジュールへの依存関係を設定
angular.module('myApp', ['hc.marked'])
  .controller('MyController', ['$scope', function($scope) {
  }]);

 Angular Markedでは、内部的にMarkedというライブラリを利用しています。Angular Markedを利用する際には、Marked→Angular Markedの順でインポートしてください(1)。また、アプリモジュール(myApp)からはhc.markedモジュールへの依存関係を宣言して、Angular Markedを有効化します(2)。

 あとは、Markdownテキストを埋め込むコンテナー要素(ここでは<div>要素)に対してmarkedディレクティブ(属性)を付与した上で、ng-includeディレクティブで.mdファイルを指定するだけです(3)。これで指定された.mdファイルがHTML形式に変換されたうえで、<div>要素配下に埋め込まれます。


  • LINEで送る
  • このエントリーをはてなブックマークに追加

著者プロフィール

  • WINGSプロジェクト(ウイングスプロジェクト)

    <WINGSプロジェクトについて> 有限会社 WINGSプロジェクトが運営する、テクニカル執筆コミュニティ(代表 山田祥寛)。主にWeb開発分野の書籍/記事執筆、翻訳、講演等を幅広く手がける。2018年11月時点での登録メンバは55名で、現在も執筆メンバを募集中。興味のある方は、どしどし応募頂...

  • 山田 祥寛(ヤマダ ヨシヒロ)

    静岡県榛原町生まれ。一橋大学経済学部卒業後、NECにてシステム企画業務に携わるが、2003年4月に念願かなってフリーライターに転身。Microsoft MVP for ASP/ASP.NET。執筆コミュニティ「WINGSプロジェクト」代表。 主な著書に「入門シリーズ(サーバサイドAjax/XMLD...

バックナンバー

連載:AngularJSアプリ開発を支援する便利モジュール

もっと読む

All contents copyright © 2005-2018 Shoeisha Co., Ltd. All rights reserved. ver.1.5