[Github] Jekyll 블로그 형식 메뉴얼 만들기 (1)

어쩌다 알게되었나 ?

간단하게 메뉴얼 작성을 할일이 생겼는데 개발자가.. 메뉴얼?! 어쨌든 난 개발자인데 더이상 웹 에디터에다가 막 사진 붙여넣고 텍스트 입력하는 짓 하기싫다.

물론 사진 업로드하는데엔 웹에디터 만한게 없을것 ㅋㅋ 노션을 써도되고 .. 등등

그리고 블로그 형식으로도 많이들 쓰인다는거 평소에 듣기만해서 대충 알고만 있었는데 더이상 미룰수가 없어서

메뉴얼도 이번에 이거로 만들어볼겸 여기저기 찾아보면서 하나씩하나씩 알게됐다.

그 왜 대부분 유저아이디.github.io 로 돌아가는 유저들 블로그 주소 접속하다보면 UI가 거의 다 대부분 비슷비슷하다는 생각 들텐데 바로 테마를 갖다 쓰기 때문이다. 물론 나도 갖다 쓸거다ㅎㅎ

 

Jekyll

Jekyll 는 루비로 만들어져있는 정적 사이트다.

많은 천재 선배님들이 만들어놓은 테마가 github 에 존재하니까 그거 가져다가(Fork) 그대로 갖다 쓰면된다.

github.io 에다가 연결할건데 그 부분은 좀 더 아래에서 다룬다.

 

나는 아래 테마로 정했다.

내가 Fork 한 프로젝트 https://github.com/tomjoht/documentation-theme-jekyll

GitHub - tomjoht/documentation-theme-jekyll: A Jekyll-based theme designed for documentation and help systems. See the link for

 

데모 페이지
https://idratherbewriting.com/documentation-theme-jekyll/mydoc_about_ruby_gems_etc.html

About Ruby, Gems, Bundler, and other prerequisites | Jekyll theme for documentation

 

위 사이트에 Installation 부분에 설명 아주 잘되있다

window , mac 구분해서 설치하는 법까지 친절하게 나와있으니 그대로 따라하면 설치엔 무리가 없다.

참고로 프로젝트 단순히 Fork 만 해서 내 github.io 로 돌려보고싶으면 굳이 루비는 안깔아도된다.

프로젝트 테마를 어쨋든 카피해왔으면 내가 수정을 해야 의미가 있는거니까, 수정을 하려면 로컬에서 어쨋든 개발환경을 갖춰야하는데 루비로 되어있으니까 루비를 까는거다

설치 페이지 상단에 위 스샷처럼 윈도우에 루비 설치하는 법까지 친절하게 나와있으니 자세히 보자

나는 Ruby+Devkit 3.1.2-1(x64) 로 받아서 진행했다. 

위 페이지에서 나와있는대로만 따라해도 루비 설치하는데엔 문제가없다.

 

유저아이디.github.io , 테마 Fork

계정 1개당 하나의 페이지를 가질수있다.

생성한 repo 에 setting 에 들어가면 설정을 볼수있다.

Repository name 을 그냥 본인아이디.github.io 라고 써붙히면 알아서 index.html 로 향해서 해당 페이지가 열린다.

참고로 repo 를 저렇게 도메인으로 실제 연결되는데 시간이 좀 필요하다 2~3분?

 

테스트로 알록달록 버튼의 소스들을 푸시했더니 아래처럼 잘 뜬다.

(내용은 의미없다 아무거나 내용 쳐서 그냥 index.html 로 저장해서 푸시하자)

여튼 이렇게 나만의 도메인이 잘 뜨는건 확인이 됐고

계정 하나당 하나의 도메인을 가질수 있다고했는데 , 앞에 서브도메인은 당연히  못바꾸지만, 별도 프로젝트를 향하게끔 조정은 가능하다. 예를들어 내가 Fork 한 프로젝트라던가 기존에 작업해놨던 것들이 A, B , C 등등이 있다고 했을때

 

bug41.github.io/A

bug41.github.io/B

bug41.github.io/C

이런식으로 향하게끔 조정할수 있다는거다.

 

내가 Fork 한 프로젝트

https://github.com/tomjoht/documentation-theme-jekyll

 

설정 방법은 연결하고싶은 프로젝트의 Settings - Pages - Source 부분을 처음에 None 이라고 되있는 부분을 클릭해서 해당 브랜치로 수정해주면된다.

저장하면 아래처럼 Your site is ready to be published at https://bug41.github.io/manual_test/

친절하게 도메인까지 나와있으니 접속해보면 잘 나오는걸 확인 할 수있다.

(역시 처음 연결되는데엔 2-3분 정도 소요된다.)

 

 

어쨌든 잘 뜨긴했는데 이제 실질적으로 내용을 수정하는 부분은 2편에 이어서 작성을 해보려고한다.

ruby는 처음 해보는거라 index.html 이 별도로 존재하지않는데 어디를 수정해야하는지 긴가민가한데 메뉴얼상에 친절하게 하나하나 다 나와있는듯하니 하나씩 하나씩 체크하면서 추가포스팅을 해볼 예정이다.

 

여러 Jekyll 테마 모여있는 사이트

http://jekyllthemes.org/