본문 바로가기

매일 글쓰기

Markdown으로 글쓰기 - 목차 꾸리기

 

[책 제목] Markdown으로 글쓰기

[분야] IT 모바일 > 컴퓨터 공학 > 개발방법론

[타깃] 블로그를 쓰고 싶은 개발자, 기술문서를 써야 하는 개발자

[목차]

프롤로그: 왜 개발자는 Markdown으로 글을 써야 하는가.

1장. Markdown으로 간단한 글 써보기

1) Markdown은 어떻게 생겨났는가?

2) Markdown으로 쓰면 얻는 혜택을 알자

3) Markdown 문법 알기

4) Markdown으로 할 수 있는 것과 할 수 없는 것

5) Markdown로 직접 글을 써보자

2장. Markdown으로 고급 활용 팁

1) Best practices

2) 좋은 파일명 짓기와 폴더와 파일 구조 갖추기

3) 가독성 좋은 포맷팅과 가독성을 해치는 포매팅 가이드

4) 소스코드처럼 문서파일 버전 관리하기

5) HTML, MS Word, PDF파일로 변환하기

3장. Markdown으로 블로그 만들기

1) 작업하기 좋은 Markdown editor 소개 - vscode, typora.io

2) Github Page로 블로그 만들기

3) Github Page와 Google Analytics를 연동하여 방문자 통계 만들기

4) Notion으로 블로그 만들기

5) Notion과 Google Analytics를 연동하여 방문자 통계 만들기

에필로그: 이제 개발자도 글쓰기가 필수다.


프롤로그: 왜 개발자는 Markdown으로 글을 써야 하는가.

Markdown이라고 들어봤는가? 아니면 README.md 파일을 본 적이 있는가?

거의 모든 개발자가 가입한 Github 웹서비스에서 프로젝트를 생성했다면 README.md 파일은 보았을 것이다. 확장자 .md 는 markdown을 의미한다. 간단한 구조와 이해하기 쉬운 문법으로 Markdown은 수많은 소프트웨어 프로젝트에서 기술문서 형식으로 사용된다.

쉽게 HTML로 변환할 수 있는 장점으로 많은 소프트웨어 개발사에서 외부, 내부 기술 문서를 Markdown으로 작성하고 웹페이지로 변환하여 제공하고 있다. Markdown은 단순한 텍스트 파일로 저장하여 MS-Word처럼 인코딩(Encoding) 된 문서에서 처리하기 어려운 이력 관리를 손쉽게 할 수 있다. 이전 버전과 비교도 쉽게 가능하다.

Jekyll, Gatsby, Hugo 등의 다양한 Static Site generator가 공개되어 많은 개발자가 자신의 기술 블로그를 markdown으로 작성하여 웹사이트로 제공한다.

이 책은 Markdown으로 기술 블로그나 기술 문서를 작성해야 하는 개발자를 대상으로 한다. 단순히 프로젝트 소개하는 페이지만 작성하는 markdown이 아닌 블로그나 기술문서를 제공하는 웹사이트로서 활용할 수 있는 방법을 제시한다.

"개발자라면 블로그를" 최근엔 개발자도 셀프 브랜딩이 필요한 시대이다. 개발자스러운 방법으로 블로그를 구축해 보는 건 어떨까.