/zumen-co-jp

Primary LanguageHTML

TODO

  • Gemfile が入ってないので入れる（Bundler 使ってなければ使う）
  • github-pages 使ったほうがいいかも

README

運用開始前に必要な情報

  • 1. google_analytics: トラッキングID
  • 2. authors情報：画像 ★必須 (orデザイン変更)
  • 3. authors情報：プロフ文章 ★必須
  • 4. authors情報：メールアドレス
  • 5. トップヘッダーのキャッチコピー ★必須 (orデザイン変更)
  • 6. トップヘッダーの背景画像(今はsample透かしの仮画像) ★必須 (orデザイン変更)
  • 7. ファビコン

適宜必要

  • 8. 直近利用したいカテゴリ名 ★必須 (初回に一覧ページ発行する必要ある)
  • 9. 直近利用したいタグ名 ★必須 (初回に一覧ページ発行する必要ある)

用意して使うか、デザイン変更して無くすもの

  • 10. facebook (現状OGP入れてない)
  • 11. Twitter (現状Twitterカード入れてない)
  • 12. 右上のPRしたい固定記事、または広告枠
  • 13. 右の注目記事

※10.12.13がすべて不要になる場合、右カラムが不要になるので要デザイン変更

記事作成に際して

  • 記事は、ファイル名をyyyy-mm-dd-hogehoge.mdにし、_postsディレクトリに入れてください。

    • ファイル命名に際して次の制約に注意してください。
      • 未来の日付のpostは表示されません
      • 同日postが存在する場合、作成時間順でなくファイル名でソート・表示されます。

  • 記事で使う画像はassets/imgディレクトリに入れてください。

  • 以上2点は、_site/_posts/~ , _site/assets/~ ではない ことに注意してください。

記事ファイルの書き方

次の内容を記載してください。

  • 14. 記事タイトル：任意文字列 ★必須
  • 15. author名：hamaguchi or hutakamiの記載。(これがトリガーでプロフデータ呼び出す) ★必須
  • 16. outline：任意文字列。エントリ一覧に記事の概要文章を出す ★必須
  • 17. カテゴリ名：任意文字列。カテゴリは1つのみ指定でお願いします。★必須
  • 18. 記事イメージ：エントリ一覧のサムネ用 ★必須(orデザイン変更)
  • 19. タグ：任意文字列、複数指定可 (なくてもよいが、関連記事を表示する類似検索に使う)

yyyy-mm-dd-hogehoge.md 内での記載例

---
layout: post #変更しないでください
title: ここに記事タイトル
author: hamaguchi
outline: ここに記事概要
categories: ここにカテゴリ名
image: /assets/img/sample.jpg #サムネ画像のパスを記載。画像は/assets/imgに入れます。サイズは現時点では任意ですが横長推奨です。
tags:
 - hoge
 - piyo
 - 日本語も可
 - 複数指定も可
---

ここにMarkdown(kramdown)で本文を書きます。

# 見出し1
サンプルテキスト

## 見出し2
* リスト
* リスト
* リスト

### 見出し3

![画像Alt](/assets/img/sample.jpg)

[リンクテキスト](リンクurl)
詳細は[こちら](リンクurl)。

#### 見出し4

コードの記載は

{% highlight (言語) linenos %}
(コード)
{% endhighlight %}

のようになります。

例)rubyの場合

{% highlight ruby linenos %}
def hello
  puts "hello"
end
{% endhighlight %}
  • author:では、author: hamaguchiまたはauthor: hutakamiを入力してください。
  • タグは1つのみの場合はtags: hogeのように記載します。
  • 見出しはh1〜h6です。# テキストのように#と見出し文の間に、半角スペースが必要であることに注意してください。
  • yaml FrontMatter内(---で囲まれた部分)では、半角スペースでインデントする必要があることに注意してください。

把握済みの不完全な点

  • カテゴリ・タグをクリックすると、リンク切れが発生しています。
    • 記事内で記載した、利用するカテゴリ名・タグ名のデータを受けて、リンク文字は自動生成されます。
    • 特定のカテゴリ名・タグ名の一覧を呼び出すhtml自体は手動で生成する必要があります。
    • このため、リンク文字は存在し、呼び出すページは存在しない状態となります。
    • 特定のカテゴリ名・タグ名を使用する初回に各一覧ページを生成すると解決します。