Skip to content

README.md

Latest commit

 

History

History
38 lines (26 loc) · 881 Bytes

README.md

File metadata and controls

38 lines (26 loc) · 881 Bytes

Git Diary

A simple markdown-based diary writing app managed with Git

🌐 Languages: English | 한국어

Usage

Easily run with the just command.

Installation

  1. Clone the repository with git clone
  2. Install just if not already installed
# macOS (Homebrew)
brew install just

# windows
scoop install just
# or
choco install just

Remote repository

  1. Create a private repository on GitHub to store your diary
  2. Link the private repository using just link <repository_url>

Writing a diary

  1. Run just new to create a new diary markdown file. A file named yyyy-mm-dd.md will be generated in the contents directory.
  2. Open contents/yyyy-mm-dd.md with your preferred code editor and write your diary.
  3. Run just publish to commit and push your diary to the remote repository.