はじめに
ここではブログ記事を書く方法を説明しています。プログラマの方とそうでない方で2通りの方法があります。
とりあえず記事を書きたい!難しいことは考えたくない!という方はこのまま読み進めてください。
GitやNode.js等の基礎的な知識のある方はプログラマの方のセクションをご覧ください。
内容について
GITYにいる方なら誰でも記事をかくことができます。技術系でなくとも勉強のこと、遊びのこと、なんでも問題ありません。
これまでSlackに貼られていたイベント告知やその様子、感想等を発信していくのも面白いかなと考えています。 他にも、発信したいことがあればなんでもOKです。どんどん発信をしていきましょう。
書きたい記事の概要をハヤオに送ってください。一緒にいい記事を書いていきましょう。
初めて記事を書く方へ
記事を書こうと考えてくださりありがとうございます。このブログの記事はMarkdownというものを使って書かれています。
Markdownを書いたことある方
Markdownをご存知の方はその記法に従って記事を書いてくれると助かります。
詳細な書き方はインターネット上で広く公開されているので検索してみてください。
また、カテゴリやタグを以下のように設定できます。これはFrontmatterという記法で、Markdownの先頭に追加します。(書かなくてもいいです)
|
|
よくわからない…という方
マークダウンがわからない人は単なる文章だけでも大歓迎です。ただし、以下のことに注意して文章を書いてください。
- 画像を好きな場所に挿入できます。画像データと挿入したい位置を教えて下さい。
- リンクを好きな位置に挿入できます。URLがわかるように明記してください。
- 見出しを複数レベル(大きい順に1~5)で設定できます。見出しから目次が自動生成されるため、見出しを明確にしてください。
- カテゴリやタグを自由に設定できます。
以下がサンプルです。
|
|
記事を提出する
記事のURLの末尾に好きなIDを設定する必要があります。英数字とハイフンが使えますので、記事を提出する際に伝えてください。
SlackかTwitterで山田ハヤオにご連絡ください。
プログラマの方
GitやGitHubを使い慣れている開発者の方は、以下の方法で開発環境を構築し記事を執筆できます。 こちらのほうがレビュー作業等をスムーズに行えます。
技術的な仕様
このブログはHugoとStack themeによって構築されている静的ウェブサイトです。
GitHub ActionによってGitHub Pagesにデプロイされています。
ソースコードはGitHubに公開されており、OSSとして公開されています。
マークダウンパーサーはgoldMarkを使用しており、記事の記法はCommonMarkに従う必要があります。
FrontmatterにはYAMLを用いてください。MarkdownLintをパスしていると嬉しいです。
開発環境の構築
以下の開発用ツールをインストールしてください。
環境を構築語、ソースコードと依存関係をダウンロードしてください。
(CATENASのリポジトリへのアクセス権がない方はフォークしてください。)
|
|
ブランチ名は名前/好きなブランチ名
の形式で作成してください。
以下のコマンドでローカルサーバーが立ち上がれば、環境構築に成功しています。
|
|
新しい記事を作成
以下のコマンドを利用して記事ファイルのテンプレートを生成してください。
|
|
生成されたファイルを編集して記事を作成してください。 編集時にはサンプルも合わせてご覧ください。
記事が完成したらコミットしてください。
|
|
作成後、プルリクエストを作成してください。
ハヤオへの連絡方法
Code for GunmaのSlackもしくはTwitterのDMまで連絡をお願いします。