Skip to content

Latest commit

 

History

History
59 lines (47 loc) · 3.39 KB

writing_process.md

File metadata and controls

59 lines (47 loc) · 3.39 KB
Raw

るびまを手元で動かす

Ruby 3.2+ が必要です。

$ git clone [email protected]:rubima/magazine.rubyist.net.git
$ cd magazine.rubyist.net
$ bundle install
$ bundle exec jekyll serve -I --future

http://127.0.0.1:4000/ にローカル開発サーバーが起動し、Markdownから生成されたHTMLページを確認できます。

るびまに記事を追加する

  • 記事は、articles/号数/_posts/yyyy-mm-dd-号数-記事名.mdとして作成してください。
  • 画像ファイルなどはimages/号数-記事名以下に配置してください。
  • ファイル名にあるyyyymmddの部分は、号数のリリース予定日です。これはるびま編集部が決めます。
  • 記事名は、以下の要領で命名してください。
    • 表紙はindex
    • 巻頭言はForeWord
    • 編集後記はEditorsNote
    • 地域Ruby会議レポートはhogehogeRubyKaigiXXReport
    • その他の記事は適当な英語名で
  • 記事を https://github.com/rubima/magazine.rubyist.net の master ブランチに対してPull Requestで出してください。
  • 記事はMarkdownで書きます。後述する書式とローカル環境の構築の方法を参照して、ご自身の環境でレイアウトなどを確認されてからPull Requestを出していただけると助かります。

書式

記事はMarkdownで記します。具体的には、kramdownを使っています。詳細な文法はkramdownのSyntaxページを参照してください。

書き方について、いくつか注意点があります。

  • 記事の先頭には以下のテンプレートを記してください。
---
layout: post
title: タイトル名
short_title: 短いタイトル名
tags: 後述
post_author: 書いた人の名前
created_on: リリース予定日
---
{% include base.html %}
  • tagsについては、号数の他に種別を記してください。
    • 種別は、記事名と同じですが、地域Ruby会議の場合はregionalRubyKaigiも指定してください。
    • このtagで指定した内容に応じてバックナンバーの記事一覧を生成しています。このため、大文字小文字も厳密に区別します。
  • 過去記事へのリンクは{{base}}{% post_url articles/号数/日付-記事名 %}をURLとして指定してください。
  • 画像へのリンクは{{base}}{{site.baseurl}}/images/号数-記事名/ファイル名をURLとして指定してください。
  • 見出し（HTMLでいうとH1やH2など、Makrdownでいうと#や##など）は、第一レベル（HTMLでいうとH1タグ、Markdownでは#）は使わず、第二レベル（HTMLでいうとH2タグ以降、Markdownでは##以降）を使ってください。
    • 上記のヘッダに書いたtitleを第一レベルの見出しにしているためです。
  • URLだけを記述しても自動リンクにはならないので、<URL>のようにURLを<と>で挟むようにしてください。
  • 記事の最後には著者についての見出しを作成して、書いた人がわかるようにしてください。
  • GitHubのリンクを乗せる場合はmasterではなく、該当バージョンへのリンクにするようにしてください。
    • masterへのリンクは将来的に変更される可能性があるためです。