Blogの書き方

この記事は弊鯖民に向けた記事です.
共同開発鯖 Advent Calender 2021の4日目の記事でもあります.

共同開発鯖のカレンダー | Advent Calendar 2021 - QiitaQiita Advent Calendar

共同開発鯖のカレンダーページです。

qiita.com

最初に

ブログのデータはすべてここで管理されています.

GitHub - Growthers/blog-data

Contribute to Growthers/blog-data development by creating an account on GitHub.

github.com

作業をするにあたって, このリポジトリをForkしてください.

ユーザーの作成

記事を初めて書く場合, ユーザーを作成する必要があります.
hogeというユーザーを作成する場合, articles/にhogeというディレクトリを作成してください.

ディレクトリ名を作成するにあたって

このディレクトリ名はURLのパスなどにも使用されます.
なるべく変更せず, 半角英数字を使用してください.

`profile.json`の作成

以下の形式に従って, profile.jsonというファイルをarticles/hogeに作成してください.

{
    "name": "Your Display Name",
    "icon": "Your Icon URL",
    "bio": "Your Biography",
    "site": "Your Website URL",
    "github": "Your GitHub ID",
    "twitter": "Your Twitter ID",
    "roles": ["Your Role 1", "Your Role 2...", "Your Role N"]
}

key	description	require
name	表示名	必須
icon	アイコンURL
bio	自己紹介
site	サイトURL
github	GitHub ID
twitter	Twitter ID
roles	役割（配列）

記事の作成

記事を作成する場合, articles/hogeに記事名のディレクトリを生成してください. (半角英数字を推奨)
ユーザー名と同じく, ディレクトリ名がそのままURLのパスになります.

その後, 生成したディレクトリにindex.mdというファイルを作成し, そこに記事を書いていきましょう.
index.md以外のファイル名を使用することはできません.

fugaという記事をhogeというユーザーで作成した場合のディレクトリ構成

├ README.md
└ articles
    └ hoge
        ├ profile.json
        └ fuga
            └ index.md

メタ情報の設定

index.mdの先頭にメタ情報を設定する必要があります.

key	description	require
title	記事の表示タイトル	必須
date	記事の作成日 `yyyy-mm-dd` の形式	必須

例:

---
title: fuga
date: 2021-12-01
---

メタ情報は今後のブログのアップデートとともに増えていく予定です.

画像の挿入

以下のいずれかの方法によって記事で画像を使用することができます.

方法	詳細
記事と同じディレクトリに保存する
外部に保存する	imgurなど

Imgur: The magic of the Internet

imgur.com

ツイートを掲載する

ツイートを掲載したい場合, URLのみを貼り付けるのではなくこちらのサイトを使用して, 埋め込みコードを貼り付けてください.

Twitter Publish

publish.twitter.com

弊鯖のアイコンを .@771tenNext さんに書いていただきました✨
これからも弊鯖は色々やっていきます！#共同開発鯖 https://t.co/oEuvdeFf0J
— 共同開発鯖 | Growthers (@UdcGrowthers) May 25, 2021

記事の投稿

記事を書き終えたら, 投稿をしましょう.
最初にForkしたリポジトリにコミットをして, blog-dataにプルリクエストを出します.