개발 가이드 작성

가이드 컨텐츠는 git 으로 관리되고 있습니다. 신규 페이지를 만들거나 수정할 경우 branch 를 만들어 작업하고, 완료된 내용은 Pull Request를 만들어 검수 후 병합합니다. 컨텐츠는 .md(markdown) 으로 작성되어 jekyll 에서 html 문서로 변환됩니다.

개발 가이드 클론

https://github.com/TqoonDevTeam/tqoondevteam.github.io.git

Branch 생성

개발 가이드는 git 으로 관리되며 작업별로 Branch를 만들어 작업합니다.

Branch 이름 규칙

  • feature/{작업자 이니셜}/{작업 내용}
  • ex) feature/KJH/jsCodingConvention

메뉴 수정

\_data\sidebars\menu.yml

파일을 수정합니다. jekyll은 이 파일을 기준으로 메뉴를 생성합니다.

- title: "개발가이드"   # 해당 메뉴에 표시될 텍스트 입니다.
  fa : "fa-question"    # 해당 메뉴에 아이콘을 표시하고 싶은경우 입력 
                        # 사용가능한 아이콘은 /vendor/font-awesome/icon.html 참조
  items:                # 하위 메뉴가 있을 경우 items 항목에 나열, 없으면 url 항목에 주소 입력
    - title: "소개"     # 하위 메뉴 항목들은 - 로 구분
      url: "/pages/devguide/guide/introduce.html"   # 각 .md 파일은 같은 경로의 .html 로 접근 가능
    - title: "jekyll 설치"
      url: "/pages/devguide/guide/jekyll.html"
    - title: "가이드 작성"
      url: "/pages/devguide/guide/write.html"

가이드 작성

개발 가이드 컨텐츠는 모두 \pages\devGuide 폴더 하위에 존재합니다. 메뉴 구성과 동일하게 폴더로 분리되어 있습니다. 모든 가이드는 markdown 문서로 작성되어 있으며 이 문서에서는 Visual Code 와 Typora 를 이용한 markdown 문서 수정 방법을 가이드 합니다. markdown 작성에 익숙한 경우 Visual Code 사용을 권장합니다.

비쥬얼코드에서 작성

git 버전관리, jekyll 실행이 가능하며, markdown 문서를 직접 수정하기 때문에 사용이 익숙한 경우 추천합니다.

  • Visual Code 설치
  • Markdown Preview Github Styling 확장 설치
  • Ctrl + K, V 단축키로 미리보기 활성화

Typora 에서 작성

Typora 는 Wisywig 에디터입니다. markdown 문법이 익숙하지 않은경우 추천하며, 맞춤법 검사기를 내장하고 있습니다.

가이드 템플릿

\pages\devGuideTemplate.md 파일을 복사하여 사용

MARKDOWN 문법

다음 문서를 참고 바랍니다. https://gist.github.com/ihoneymon/652be052a0727ad59601 가이드 템플릿 에도 사용가능한 대부분의 Markdown 문법이 포함되어 있습니다.

배포

가이드 작성 완료 후 Pull Request 만들어 개발 밴드에 리뷰 요청을 올립니다. 모든 가이드는 검수 후 master 에 병합 합니다.