tanikoのぶろぐ

saori

概要

saoriはgithub.ioでブログをするための静的サイトジェネレータです. PHPで作られていてターミナル上で動作をさせます. MarkdownとJSONでブログの記事や設定を記述していきます.

始め方

インストール

インストールはComposerからできます

composer create-project hrgruri/saori-skeleton blog

初期化

インストールが終わったら初期化をしましょう. 初期化をすることで,必要最低限の設定ファイルが生成されます.

php saori init

そうするとcontents/config.jsonができていると思うので, 必要なところを編集してください. idはGitHubのアカウント名です.

使い方

記事を投稿する

php saori draft :article_title

これでdraft/:article_titleディレクトリが生成されます. 中にはarticle.mdとconfig.jsonがあるので,記事の設定(タグやタイトル)と記事(Markdown形式)を書いていきましょう.

書き終えれば次のコマンドを実行します.

php saori post :article_title

こうすると先に書いた記事がcontents/yyyy/mm/:article_titleに移動されます.

サイトを生成する

いよいよサイトを生成します.

php saori build

これでlocalとusername.github.io (username部分はcontents/config.jsonのid)が作られます.
公開する前にどのようなサイトが生成されたのかを確認してみたいと思います. 確認にはPHPのビルトイン･サーバを使いましょう.

php -S localhost:8000 -t local

ブラウザでhttp://localhost:8000にアクセスしてみましょう.

GitHubにPush

まずはGitHubに｢username.github.io｣というリポジトリを作成しましょう. username部分はGitHubのアカウント名です. 

cd username.github.io
git init
git remote add origin git@github.com:username/username.github.io.git
git add --all
git commit -m 'Initial commit'
git push origin master

その他

config.jsonを編集することでブログの設定を変えることができます. それ以外にもtheme.jsonでテーマごとの設定を上書きすることができます. (できない部分もあり)

{
    "saori": {
        "color": {
            "header" : "#A9EEE6",
            "title" :"#F7FBFC",
            "body":"#FEFAEC",
            "page-contents": "#FFF1CF"
        }
    }
}

これは,saoriというテーマを使用した際に使用する色を変えるためのものです. 変更できる箇所と名前はテーマによって異なるので注意してください. saoriテーマはここで確認することができます.