/ FRAGMENTARY-KNOWLEDGE

What is GitHub Gist?

Introduction

Code Snippet을 관리하기 위한 도구입니다. 블로그로 IT 관련 포스팅을 하는 사람들에게는 굉장히 유용한 도구로 사용이 됩니다. Gist는 우리나라말로 “지스트”라고 발음하며 GitHub에서 서비스 하고 있습니다.

만일 Gist에 대해서는 알고 있고 jekyll기반의 GitHub Page에서 사용하는 방법에 대해서 알고 싶으신 분은 여기를 참조하세요!


Code Snippet 관리

IT 개발관련 블로그를 운영하다보면 여러 코드조각들을 블로그에 같이 올리게됩니다. 어떤 경우는 말 그대로 완성되지 않은 “코드조각” 형태의 코드를 올리기도 하고 어떤 경우는 완성된 형태의 코드를 올리기도 합니다.

텍스트 형태로 그냥 포스팅을 하면 보기가 너무 좋지 않으니 일반적으로 Syntax Highlighter를 많이 이용하게 됩니다. 다양한 종류의 Syntax Highlighter가 있고 이를 이용하면 보기 좋게 코드들을 블로그에 올릴 수 있습니다.

설명을 하기 위한 코드조각들은 일반적으로 수정이나 공유의 빈도가 상대적으로 적기 때문에 그냥 Rouge와 같은 Syntax Highlighter를 이용하여 올리면 편합니다. 하지만 완성된 코드를 포스팅하는 경우 추후에 기능의 보완이라든지 오류에 대한 수정같은 이슈가 생길 수 있고 이렇게 변경된 코드는 다른 사람과 공유할 때 문제가 발생할 수 밖에 없습니다. 하나의 완성된 코드를 블로그 여기저기에서 가져다가 쓰는 경우 역시 마찬가지의 이슈가 발생할 수 있겠죠.

결국 “YouTube에 동영상을 올리고 블로그에 삽입하는 것처럼 이런 코드조각들도 그렇게 관리하고 공유하면 편하겠다” 라고 사람들이 생각하게 되고 이를 위한 온라인 서비스도 여러 개 생기게 되었는데 그 중 하나가 GitHub에서 제공하는 Gist입니다.

결론적으로 Gist는 Code Snippet을 관리하고 공유하도록 도와주는 서비스라고 생각하시면 됩니다.


사용방법

사용방법은 상당히 간단합니다. 일단 GitHub에 로그인해서 노란색 영역을 클릭하시면 다음과 같은 화면을 보실 수 있습니다.

Gist 생성

New gist 메뉴를 선택하면 Code Snippet을 생성할 수 있는 화면으로 전환됩니다.

Code Snippet 작성

코드 내용을 입력하고 public 혹은 secret 형태로 gist를 생성합니다.

생성이 되면 아마 다음과 같은 화면을 보실 수 있을텐데 이렇게 작성된 gist를 블로그에 올리려면 Embed라고 되어있는 JavaScript link code를 가져다가 블로그에 삽입하면 됩니다.

Code Snippet 공유

실제로 한번 작업해 보시면 자신이 작성한 Code Snippet을 블로그에 쉽게 포함 시킬 수 있으실 겁니다.

저는 Jekyll기반의 GitHub Page에서 블로그를 운영하고 있기 때문에 조금 다른 방식을 이용합니다. Liquid template을 이용해서 블로그에 포함시키는 방법을 이용합니다.

이 방식에 대해서는 여기를 참조하세요!

End.