2015年9月20日日曜日

ウェブ・ページにソースコードをスタイリッシュに表示する方法(GitHub編)

経緯

ブログを書いていてソースコードを掲載することがあるのですが、ページに記載することが多くなりタグで書くのは面倒だったので簡単に貼り付けれるような方法を探してみました。

Goles(いつものように目標設定)

  1. ソースコードをWebページにかっこよくハイライト表示できること。
  2. 出来れば、タグなどを付与せずそのまま貼り付けたい。
  3. Java、HTML,JavaScriptに対応しているいること。

選定

検索してみると条件を満たせそうなものとして、以下のものが見つかった。
  1. SyntaxHighlighter
  2. GitHubのGistを利用して、自分のページにScriptを埋め込む
今回は、GitHubを選定してみました。理由は、GitHubに興味があり、一度使ってみたかっただけです。

GitHubとは?

個人的には以下の理解です。(まじめには勉強していないので感覚的なものです。正しい理解をしたい方は、自分で調べてみてください)
  1. ソースコードがバージョン管理できる。
  2. 世界中の人がレビューしてくれる。
    今回サンプルをアップしましたが、1時間ほどで3人ほどレビューしてくれました。たいしたものをアップしなかったので、修正はありませんでしたが、すぐに見てくれる人がいるのはすごい!!
  3. ついでに、評価もしてくれる。(ソーシャルネットワークの「いいね!」にあたるものが用意されていますが、、、何でもかんでも「いいね!」には賛同できかねますが)
開発をかれこれ、20年ほどやっていますが、こんなに簡単にグローバルに開発が行えてしまう状況はには正直、感動します。いろいろと感じた点はあるのですが、話がそれそうなので、別の機会にします。

作業の流れ

  1. GitHubへユーザ登録
  2. GitHubへログインし、Gistでソースコードを登録する。
  3. 好きなページにスクリプトを埋め込む
上記の4ステップです。実際やってみましたが、私はGoogleのBloggerを利用しており動的ページを利用していると表示できないという罠にはまった以外はあっさりとうまくいきました。

1.GitHubへのユーザ登録

ここは省略します。
必要がある方は、ここから登録できます。

2.GitHubへログインし、Gistでソースコードを登録する。

ログインすると以下の画面が表示されます。


画面上にある、Gistをクリックします。

ソースコードを入力します。
ファイルの拡張子でハイライト表示が変わるみたいなので必ず拡張子を入力すること


作成したら、Create secret gistをクリック

3.好きなページにスクリプトを埋め込む

画面右にある、Embed URLのアイコンをクリックすると
クリップボードに貼り付けるScriptタグがコピーされます。

自分のブログやホームページに貼り付けると完成です。
ちなみにこんな感じです。

Eclipseでソースを見てるみたいです。かっこいいので、皆さんもブログなど自分のコードを公開する場合は利用してみたください。

0 件のコメント:

コメントを投稿