[Markdown Toc] Markdown 콘텐트를 랜더링, 목차를 만들어 주는 소스 공개

필자 만든 소스 코드가 GitHub에 올린 것들이 20여 가지가 넘어간다.
소스 코드도 중요 하지만 이것을 잘 설명하는 것도 무척 중요한 것 같다. 거기에 예쁘게 꾸밀 수 있다면 이건 신이 주신 능력임이 분명할 거다. ㅠ

Markdown ToC (Table of Contents)

이런 어려움에 착안하여 Markdown ToC를 만들어 GitHub에 공개했다.
링크 : https://github.com/powerumc/markdown-toc

Markdown ToC는 Markdown 문법을 이용하여 만든 문서에 목차를 만들어 주는 라이브러리이다. 진짜 별 거는 아니고, 필자가 필요해서 쓱~ 만들었다.

MIT 라이센스로 공개 했으며, 이미 잘 만들어진 marked.js, tocify.js 라이브러리를 조합하여 간단하게 만들어 보았다.

디자인이나 기능을 추가 하신 분은 Pull Request 올려 주세요.

아래는 Markdown Toc로 만들어 본 필자 저장소의 gh-pages 웹 페이지이다. (현재 모바일 미 지원)

• http://powerumc.github.io/vsgesture
• http://powerumc.github.io/js-lambda
• http://powerumc.github.io/array-extensions

Features

사소하지만 몇 가지 특징이 있다.

1. Markdown ToC 코드를 받고 원하는 곳에 올리기만 하면 된다. (gh-pages 브랜치 등)
2. 브라우저에서 실시간으로 Markdown 파일을 랜더링한다.
3. README.md 파일만 수정하고 로컬 컴파일이 필요 없다.
4. Jekyll, Assemble 등 템플릿 문법을 익힐 필요가 없다.
5. 심플하다.

How to - Beginner

1. 소스 코드 다운로드

필자의 GitHub 저장소에서 master.zip 파일을 다운로드 받고, 풀면 된다.

2. 올리고 싶은 곳에 올린다

올리고 싶은 곳에 올리면 된다.

How to - Pro Git

1.다음과 같이 Markdown ToC 를 clone 한다.

$ git remote add markdown-toc https://github.com/powerumc/markdown-toc.git  

2.GitHub에서 웹 페이지를 호스팅 할 수 있는 gh-pages 브랜치를 생성하고, Markdown ToC 소스 코드를 받는다.

$ git checkout --orphan gh-pages  
$ git rm -rf .  
$ git commit -am "remove all file for gh-pages"  
$ git pull markdown-toc master:gh-pages  

3. 콘텐트 수정 또는 생성

README.md 파일에 원하는 콘텐트로 채운 후에 커밋을 하면 된다.

$ git commit -am "init commit."  

만약 다른 브랜치에 이미 만들어 놓은 README.md 파일이 있으면 gh-pages 브랜치로 가져오면 된다.

$ git checkout master -- README.md  
$ git commit  

3. GitHub 에 Push 한다.

$ git push origin gh-pages