毎日の学びを簡単に管理するTILリポジトリの作り方

毎日の学びを簡単に管理するTILリポジトリの作り方

毎日の学び:TIL(Today I Learned)をGitHubのリポジトリに追加し、簡単に管理していきます。※なお、アイキャッチ画像はChatGPTで生成しました。

概要

  • なるべく簡単な運用にするため、GitHubのリポジトリにTILを追加することで管理
    2024/09/01追記:複数リポジトリの管理は煩雑なため、既存のリポジトリ配下に配置変更
    GitHub : サンプル投稿
  • 歯磨きと同じくらいの時間で、毎日の学習を簡単に管理する
  • シェル一発で投稿可能なので手間にならない(60秒以内で投稿可能)

メリット

  • GitHubに投稿するので、共有や振返りが可能
  • ISSUE管理も可能
  • 副次的効果として、簡単な英語で記載することで、英語の短文日記を作れる。(毎日英語に少しずつ触れて、トレーニング効果が見込める)
  • 学習と思わず、ただの習慣としてゆるく続けることが可能(忙しい日は一文投稿でもOK)

デメリット

  • 最短60秒以内で完了するので、今のところ特になし

簡単な手順

TIL(Today I Learned)を管理するための簡単な手順を以下にまとめます:

### TIL管理手順

1. 開発環境でのTIL作成

  • 作業ディレクトリの設定: 本日学んだ内容に基づいて、開発環境でTILエントリーを作成します。※私はGitHubのCodespacesを利用しています。
  • ディレクトリ構成の確認: 以下のように、日付ごとにフォルダとMarkdownファイルを作成することができます。

“`
entries/
├── 2024/
│ ├── 07/
│ │ ├── 2024-07-01.md
│ │ ├── 2024-07-02.md
│ │ ├── …
│ │ └── 2024-07-31.md
└── …
“`
– 内容の記入: Markdownファイルに、その日に学んだことを簡潔に記入します。

2. リポジトリの作成と管理

  1. – GitHubリポジトリの作成:
    1. GitHubにログインし、新しいリポジトリを作成します。
    2. リポジトリ名に「TIL」と入力し、公開設定や説明を追加して「Create repository」をクリックします。
  2. – ローカルリポジトリの設定:
    “`sh
    git clone <GitHubリポジトリURL>
    cd TIL
    “`
  3. – ファイルの追加: TILファイルを作成し、指定のディレクトリに保存します。

3. コミットとプッシュ

  1. – 変更のステージング:
    “`sh
    git add entries/2024/07/2024-07-05.md
    “`
  2. – コミット:
    “`sh
    git commit -m “Add TIL for 2024-07-05”
    “`
  3. – リモートリポジトリへのプッシュ:
    “`sh
    git push origin main
    “`

サンプル投稿(GitHub)

GitHub : サンプル投稿


## Sample Entry

Here is an example of what a typical entry looks like:

```
# Today I Learned

## 2024-07-05

### Today's Learnings
- UoPeople ENGL0008 Unit 4 Learning Guide
- Unit 4 Self-Quiz
- Created a TIL (Today I Learned) repository and Setting up



## Setup Instructions
Note: Steps 1-4 are only for the first time.

1. Create a GitHub Account
   - Go to the GitHub official site (https://github.com) and create an account.

2. Create a TIL Repository
   - Sign in to GitHub, click on the "+" icon in the upper right corner, and select "New repository".
   - Name the repository "TIL" and enter the necessary information, then click "Create repository".

3. Set Up Local Repository
   - If Git is not installed, download and install it from the [Git official site](https://git-scm.com/).
   - Open the terminal and run the following commands to clone the repository:
     ```sh
     git clone 
     cd TIL
     ```

4. Add Daily Outputs
   - Create new directories and files for the date. For example, to create an entry for July 5, 2024:
     ```sh
     mkdir -p entries/2024/07
     echo "# Today I Learned" > entries/2024/07/2024-07-05.md
     ```
   - Open the file in your text editor and write what you learned that day.

5. Commit Changes
   - In the terminal, run the following commands to commit the changes:
     ```sh
     git add entries/2024/07/2024-07-05.md
     git commit -m "Add TIL for 2024-07-05"
     ```

6. Push to Remote Repository
   - Run the following command to push the changes to the remote repository:
     ```sh
     git push origin main
     ```

## Make Daily Outputs a Habit

- Daily Reminders
  - Use a calendar app or reminder app to set reminders for writing your daily TIL entries.

- Consistent Commits
  - Write at least one TIL entry each day, then commit and push using the steps above.

## Additional Tips

- File Structure
  - Customize the file structure to suit your needs. For example, you can create directories for different categories.

- Using Markdown
  - Writing in Markdown makes the entries easy to read on GitHub. Refer to the [Markdown Guide](https://www.markdownguide.org/) for basic syntax.
```

TIL一発投稿シェルのサンプル(GitHub)

GItHub: create_til_entry.sh