마크다운 기반 문서 작성

 

학습 목표

마크다운 특징

마크다운 활용 예시

 

학습 목표

• 2004년 존 그루버가 만든 텍스트 기반의 가벼운 마크업 언어

• 최초 마크다운에 비해 확장된 문법(표 주석 등)이 있지만 본 수업에서는 깃허브에서 사용 가능한 문법을 기준으로 설명

 

마크다운 특징

• 워드 프로세서는 다양한 서식과 구조를 지원하지만, 다른 프로그램으로 호환에 제약이 되며 워드프로세스 상의 기능을 활용해야 함

• 마크다운은 최소한의 문법으로 구성되어 있으며 순수 텍스트로 작성 가능

 

마크다운 활용 예시

• README.md
  • 오픈소스의 공식 문서를 작성하거나 개인 프로젝트의 프로젝트 소개서로 활용
  • 혹은 모든 페이지에 README.md를 넣어 문서를 바로 볼 수 있도록 활용

• 정적사이트생성기 기반 블로그
  • Jekyll,Gatsby,Hugo,Hexo 등으로 작성된 마크다운을 HTML,CSS,JS 파일 등으로 변환하고, Github pages 기능을 통해 무료 호스팅이 가능함

 

• 마크다운 기반 SW
  • Jupyter notebook에는 별도의 마크다운 셀으로 프로젝트 내용과 분석 결과를 정리 가능함
  • Notion과 같은 메모/노트 필기 SW 역시 마크다운 기반 문서 작성을 기본으로 함

 

• 마크다운 문법Heading : 문서의 제목이나 소제목
  • #의 개수에 따라 대응되는 수준이 있으며 h1 ~ h6까지 표현 가능
  • 문서의 구조를 위해 작성되며 글자 크기를 조절하기 위해 사용되어서는 안됨.
  • #서론 (##개요, 배경(###국내, 국외), 목적)- #본론(##1,2,3,,,) - #결론 (##결론, 제안)

  

  

  주의할 점
  • 띄어쓰기, 오타 잘 확인하기
  
  
  • 순서가 있는 리스트(ol)와 순서가 없는 리스트(ul)로 구성
  • Tab으로 하위 항목으로 구성할 수 있음

  

  
  
  • 코드 블록은 backtick 기호 3개를 활용하여 작성(``` ```)
  • 코드 블록에 특정 언어를 명시하면 Syntax Highlighting 적용 가능

  

  
  
  • 코드 블록은 backtick 기호 1개를 인라인에 활용하여 작성(` `)
  
  
  • [문자열](url)을 통해 링크 작성 가능
  
  
  • 을 통해 이미지를 사용 가능
  • 특정 파일들 포함하여 연결 시킬 수도 있음
  
  
  • >으로 인용문을 작성
  
  

  

  • 위 처럼 입력 하면 된다.
  • 지원되지 않는 곳도 있다.
  • 일일이 쳐야하는 어려움이 있기 때문에 구글에 마크다운 활용을 검색해 사용해 볼 수 있다.
• 테이블
• Blockquotes : 인용
• image : 이미지
• link : 링크
• Inline Code block : 코드 블록
• Fenced Code block : 코드 블록
• List : 목록

 

텍스트 강조

• 굵게,기울임을 통해 특정 글자들을 강조.

  

 

수평선

• 3개 이상의 (***), (-),(_사이 글_)

개발자에게 문서 작성이란?

• 백엔드 개발자를 꿈꾸는 학생 개발자들에게
  • 레벨 2 개발자 : ‘자신이 경험한 사용법을 문서화해서 내에 전파할 수 있음’

• Goolge Technical Writing

• Technical writing conference
  • Clova 기술 문서 작성 및 관리 업무

 

외부 링크

깃허브 블로그에 적용되는 markdown 문법

 

Markdown Guide