re:inventing the wheel

それでも車輪は回っている

Octopress備忘録(2) 記事の投稿

前回、GitHub Page + Octopressの環境を構築してみました。 今回は記事の投稿方法についてメモを残します。

記事の作成

以下のコマンドにより記事を作成できます。

1
$ bundle exec rake new_post['post title']

rake new_postの引数 post title はURLでも利用するため必ず半角英字にする必要があります。

実行すると、octopressのリポジトリ内の source/_posts/YYYY-MM-DD-post-title.markdown というファイルが作成されます。

作成されたファイルの内容は以下のようになります。

1
2
3
4
5
6
7
---
layout: post
title: "post title"
date: 2014-12-29 14:25:01 +0900
comments: true
categories:
---

記事タイトルの日本語化

先にも書きましたが、rake new_postコマンドの引数はmarkdownファイル生成のコマンドのため日本語は利用できません。 日本語のタイトルを利用したい場合、生成されたファイルの title:の項目を編集します。

1
2
3
4
5
6
7
---
layout: post
title: "初めての記事"
date: 2014-12-29 14:25:01 +0900
comments: true
categories:
---

記事カテゴリの設定

記事のカテゴリ設定は、categories:に配列で記述します。

1
2
3
4
5
6
7
---
layout: post
title: "初めての記事"
date: 2014-12-29 14:25:01 +0900
comments: true
categories: ['カテゴリー1', ('カテゴリー2'...)]
---

記事本文の記述

記事本文は、rake new_postで作成された情報の末尾にmarkdown形式で記述していきます。

記事のプレビュー

作成した記事をGitHubに登録する前に下記のコマンドでプレビューすることができます。

1
$ bundle exec rake preview

実行すると、http://localhost:4000 にブラウザでアクセスすることで記事の内容が確認できます。

記事の投稿

作成した記事を投稿するには以下のコマンドで登録できます。

1
$ bundle exec rake gen_deploy

なお、rake gen_deployは下記のコマンドの実行と同等です。

1
2
$ bundle exec rake generate
$ bundle exec rake deploy

編集したファイルは origin/sourceへ

つい忘れがちですが、せっかくGitHub Pageを利用しているので記事のソースや編集した設定ファイルはこまめにリポジトリにpushしましょう。

1
2
3
$ git add .
$ git commit -m 'your message'
$ git push origin source

その他

Octopressの記事フォーマットは、markdown(MD)と呼ばれる記法を使用します。 GitHub主軸の開発者であればおなじみの記法ですが、私もよく忘れるのでいつも参考しているサイトを紹介いたします。

※ちなみに、Octopress用のエディタはAtomを利用しています。 GitHub謹製なのでMDのプレビュー機能やコミットされていないファイルがハイライトされるなどちょっと便利な機能が魅力です。


とりあえず、今回は以上。