HubPress は無料でブログを作るためのオープンソースツールです。AsciiDocで書けるすばらしいブログをGitHub Pagesを使って公開できます。
Anthonny Quérouil (twitter @anthonny_q) により作成・メンテナンスされています。
Note
|
HubPress はまだ作成途中です。バグを発見した場合は是非教えてください。開発チームができる限りはやく対応します。 |
HubPressの更新が勢いに乗れば、それだけドキュメントも更新されます。 定期的にHubPressの更新を確認し、新しい機能・使い方を確認して下さい。 バグ報告はいつでも歓迎です。もちろんプルリクエストは*いつでも*大歓迎です。
もしあなたがGitHub Pagesを利用したことがなければ、ここに記載の方法で 簡単に HubPress をセットアップできます。 ほんの数ステップで HubPress がデプロイされ利用可能になります。
Important
|
「username.github.io ドメインを他プロジェクトで利用済みである」あるいは「独自ドメインで HubPress を利用したい」場合, 下記のステップは読み飛ばしてください。 |
-
リポジトリ名を
<username>.github.io
に変更 -
hubpress/config.json
の設定なお、以下のパラメータは必須です。
-
username
: GitHub のユーザー名です。 -
repositoryName
: フォーク後のリポジトリの名前。<username>.github.io
-
-
変更をコミットし,
https://<username>.github.io/
ドメインで GitHub Page を公開。 -
以下のような画面が出れば、HubPressは正しくセットアップされています。
やや多めに設定が必要です。
-
リポジトリの設定からデフォルトのブランチを
gh-pages
に設定 -
gh-pages ブランチに移動。
-
hubpress/config.json
の設定なお、以下のパラメータは必須です。
-
username
: GitHub のユーザー名です。 -
repositoryName
: フォーク後のリポジトリの名前。特に変更していないならhubpress.io
-
-
変更をコミットし,
https://<username>.github.io/<repositoryName>/
で GitHub Page を公開。 -
以下のような画面が出れば、HubPressは正しくセットアップされています。
HubPressの管理画面は /hubpress からアクセスできます。つまり
-
https://<username>.github.io/hubpress/
(github.ioドメインを利用している場合 ) -
https://<username>.github.io/<repositoryName>/hubpress/
(Project Pageを利用している場合) -
http://<yourdomain>/hubpress/
(独自ドメインを使用している場合)
です。
GitHub のログイン情報でログインできます。
一旦ログインすると、HubPress から GiHub API へコールするためのトークンが発行されます。
このトークンは HubPress の全セッション間で共有されます。 そのためPCで管理画面を開いた後、タブレット端末でも開いた場合は トークンはPC,タブレット両端末で使われます。
CNAMEやページングといった、基本的なブログの設定が可能です。 またあなたのソーシャルアカウントとブログを紐付けすることもできます。
この節は /hubpress/config.json
ファイルで変更可能な基本情報についての説明を含みます。
Git CNAME を設定可能して独自ドメインの利用が可能です。 詳しくは https://help.github.com/articles/setting-up-a-custom-domain-with-github-pages/ を見てください。
- Live Preview Render Delayの項目について
-
ミリ秒単位で、ライブプレビューが描画を始める時間を設定できます。 タイピングが早い人には、2000 (2秒) 以上の数値を入れることをオススメします。そうすると何度も頻繁にライブプレビューの描画をさせずに済むので、ブログの執筆がスムーズになるでしょう。2000(2秒)より少ない値を設定する場合は、ライブプレビューがはじまるのが早くなりますが、タイピングのカーソルに遅れなどが生じる可能性があります。
Title や Description フィールドにより ブログタイトルや, その説明を設定することができます。
Logo や Cover Image フィールドには
-
ホスティングサービス上の画像へのHTML リンク。 例. gravatar
-
/images ディレクトリ内の画像へのリンク
が設定可能です。
Note
|
ブログへの画像の投稿については /images/README.adoc を参照してください。
|
はじめて HubPress を利用する際には Posts はまだありません。 ブログに投稿をすると、左側に記事のリスト、右側にプレビューの形で表示されます。
Note
|
もし AsciiDocに馴染みがなければ AsciiDoctor Writer’s Guide で勉強して下さい。 |
HupPress エディタは左側に AsciiDoc のコード、右側にプレビューを表示します。
記事のタイトルは常に AsciiDoc 投稿における Level 1 となります。
つまり = Blog Title
により 記事のタイトルを Blog Title
に設定できます。
記事の保存には = Blog Title
が1つ必要です。
もし 1st-level のヘッダーを使いたければ代わりに == First Level Heading
を使ってください。
ネストしたヘッダも同様です。
HubPress allows you to alter characteristics of each blog post using attributes.
記事にカバー画像を追加したい場合 hp-image
属性を追加する必要があります。
例:
= Blog Title
:hp-image: https://github.com/<username>/<repositoryName>/images/a-cover-image.jpg
Note
|
HubPressは`/images`ディレクトリをすべての画像のルートとしているので、あなたがすればよいのは画像のファイル名を記述することだけです。これを踏まえると、あなたは`/covers`というカバー画像を一括で置いておくためのディレクトリをリポジトリに作成するとよいかもしれません。 一貫性のあるカバー画像の名前付けのおかげで、投稿にカバー画像を掲載するのも簡単にできます。テーマ画像を設定すれば、読者にブログの内容を視覚的に訴えることができます。 |
現在以下のテーマが投稿のカバー画像をサポートしています:
-
Saga
公開日はデフォルトで記事を作成した日になります。
published_at
属性を設定することにより、公開日を指定することができます。
例:
= Blog Title
:published_at: 2015-01-31
GitのコマンドラインやGitアプリを使ってブログ投稿に画像を追加できます。
-
画像を`images`にコミットする
-
ブログ投稿内にAsciiDoc文法に従って:
image::<ファイル名>[]
-
See http://asciidoctor.org/docs/asciidoc-writers-guide/ for complex examples of Image syntax.
もし他所にホストした画像(例えばinstagram, 他のGitHubリポジトリ,あるいはその他の画像ホストサイトなど)を埋め込むには、`<ファイル名>`に画像への完全なURLを指定してください。
image::http://<full path to image>[]
ひとつのissueにコメントで残していくような方法でブログ用の画像を用意したり、反対にたくさんのissueを作って画像を個別に管理することもできます。あなたにとって、あるいはあなたの組織にそってベストなやり方が選べます。 5分間のデモビデオを用意してあります。GitHub Issuesなどのクラウドホスティングサービスで画像を埋め込む方法とAsciiDocで画像を取り扱う方法がわかります。 https://www.youtube.com/watch?v=KoaGU91qJv8
HubPressはGitHubにホストされているので、HubPressのmasterリポジトリから最新の変更をpullするだけでアップデートできます。
初めてですか?次の動画で(コマンドライン操作を必要としない)簡単で正しい方法を学びましょう。(もちろんコマンドラインからでも問題ありません。)
何かうまくいかないことがあったら、以下のTipsをご参照ください。
Thanks to Jared Morgan for initially tidying up the README you see here, and continuing to be the "docs guy" for HubPress.
日本語訳: takkyuuplayer, hinaloe