GitHub リポジトリを作成する

GitHub リポジトリの作成について

Hacker Sheet を利用するには GitHub リポジトリが必要です。このページでは、リポジトリをどのようなディレクトリ構成で作成するのが良いかを解説します。

1. ここで作成したリポジトリをワークスペースと連携します。
2. ワークスペースにリポジトリ内の Markdown や画像を取り込みます。
3. ワークスペースごとのエンドポイントから GraphQL API でコンテンツを取得します。

今後の簡単な流れは以上です。

推奨するディレクトリ構成

hackersheet-example という名前のディレクトリを作成し、上記のようにファイルを配置しましょう。

続いて各ファイルについて説明します。

.hackersheet/settings.json

.hackersheet/settings.json はワークスペースの設定を定義するファイルです。存在しない場合はデフォルトの設定が適用されます。

{
  "returnDraftDocument": false,
  "returnGithubRepo": true
}

.hsignore

.hsignore はワークスペースに取り込みたくない Markdown や画像、またそれらを含むディレクトリを定義するファイルです。フォーマットは .gitignore と同じです。

リポジトリの説明のために README.md を作成したが、ワークスペースに取り込みたくない場合は、以下のように定義します。

README.md

docs/example.md

ワークスペースに取り込みたい Markdown ファイルは、docs などのディレクトリに作成することを推奨します。

リポジトリのルートにあるファイルも取り込まれますが、こちらのほうが整理されています。

Markdown ファイルは、以下のように YAML フロントマターを含む内容で定義します。

---
draft: false
emoji: ❔
title: サンプルドキュメント
slug: example
published_at: 2024-11-01 00:00:00
modified_at: 2024-11-01 00:00:00
tags:
  - サンプル
preview: null
---

## サンプルドキュメント

サンプルドキュメントです。

GitHub リポジトリに push する

以上のような hackersheet-example を作成したら、GitHub 上でリポジトリを作成して push しましょう。

1. https://github.com/new でリポジトリを作成する。

2. 以下のコマンドで push する（YOUR_USERNAME は適宜置き換えてください）

   Terminal

   cd hackersheet-example
   git init
   git add .
   git commit -m 'Initial commit.'
   git remote add origin git@github.com:YOUR_USERNAME/hackersheet-example.git
   git branch -M main
   git push -u origin main

次のステップ

GitHub リポジトリの作成ができたら、次はアカウントの作成を行います。