나의 Markdown 사용일지

 어느 순간부터 거의 모든 기록을 마크다운 기반으로 작성하고 있다. 여러 가지 이유가 있지만, 텍스트 기반으로 작성한다는 점에서 파일의 크기가 작고 활용이 편리하다는 장점이 있다. 종종 이미지를 활용하기도 하지만, 그러한 상황이 아닌 대부분의 상황에서는 텍스트로 문서를 작성 및 활용하고 있다.

 

Markdown

 마크다운의 기본 문법은 간단하다. 몇가지 없고, 이미 많은 자료가 있기 때문에 위키피디아 링크로 대체하겠다.

마크다운 - 위키백과, 우리 모두의 백과사전

 

 마크다운은 간편하지만, 한편으로는 너무 간단하기 때문에 순수한 텍스트 기반 문서 작성 이외에는 큰 역할을 하기 힘들어 보인다. 나도 처음에는 간단한 기록, 코드 기반 기록 등에 활용했지만 여전히 한계는 있었다. 이러한 한계를 조금 더 극복할 수 있게 한 두 가지를 소개하면 TeX, mermaid.js가 있다.

 

TeX, mermaid.js

 TeX(텍)은 문서 조판에 주로 사용하는 프로그램인데, 마크다운 뷰어 및 에디터에서 지원하는 경우가 많다는 점이다. TeX은 주로 수식 등을 나타낼 때 사용하는데, 일반적인 텍스트로 나타내지 못하는 수식을 나타낼 수 있게한다. 마크다운에서는 $사인으로 감싸서 활용할 수 있고, 한 쌍으로 감싸면 인라인으로, 두 쌍으로 감싸면 블록으로 활용할 수 있다. TeX 사용 예시는 다음과 같다.

 

 위와 같이 작성하면 아래와 같은 수식으로 출력할 수 있다.아래의 위키피디아 문서를 참조하면 더욱 다양한 수식 등을 활용할 수 있다.

위키백과:TeX 문법 - 위키백과, 우리 모두의 백과사전

 

 mermaid는 다이어그램, 차트 등을 그릴 수 있도록 도움을 수는 자바스크립트 라이브러리이다. mermaid 역시 지원하는 마크다운 에디터, 뷰어가 많다는 장점이 있다. 이를 활용하는 이유는 마크다운은 텍스트 기반의 기록을 훌륭하게 수행할 수 있지만, 도형 등을 활용해서 기록하는 경우 아쉬운 부분을 느낄 때가 많기 때문이다. mermaid의 사용 예시는 다음과 같다.

 위와 같이 코드블럭으로 작성하면 아래의 차트 등을 활용할 수 있다. 아래의 mermaid 페이지에서 더욱 다양한 예시를 살펴볼 수 있다.

mermaid - Markdownish syntax for generating flowcharts, sequence diagrams, class diagrams, gantt charts and git graphs.

 

 이 두가지를 사용하며 느낀 장담점들을 정리하면 다음과 같다.

 TeX은 수식을 빠르게 작성 및 수정할 수 있게 해 주어 매우 편리하게 사용할 수 있다. 한글, 워드 등에서도 지원하지만, 작성 및 편집을 위해 별도의 창이 열리는 등의 경우가 있는데, 마크다운에서 활용하면 텍스트를 수정하듯이 순간순간 수정 및 활용할 수 있다.

 mermaid역시 여러 가지 차트를 활용하는데 도움이 되고, 협업 과정에서 활용하기에도 좋았다. git을 통하여 마크다운 파일이 공유된 경우에도 편리하게 작성 및 수정할 수 있기 때문이다. 반면 차트 및 그래프의 종류가 다양한데 규칙이 조금씩 다르다. 위의 예시에서도 화살표를 graph에서는 -->로, sequenceDiagram에서는 ->>를 사용한다. 이러한 사소한 부분들, 그리고 추가적인 기능을 활용하기 위해 위의 문서를 확인하는 일이 많고, 그렇게 되면 차라리 구글 문서나 figma를 활용하는 게 더욱 수월하지 않을까라는 생각도 들었다. 하지만 역시 빠른 작성과 수정에는 강점이 있다.

 

생각 정리

 마크다운은 큰 강점이 있다고 생각하지만, 많은 단점이 존재한다. 위에서 소개한 TeX, mermaid는 이를 해결할수는 없지만, 불편함을 해소하는 정도는 될 수 있는 것 같다. 글 내용에서는 소개하지 않았지만, 만약 더 좋은 방법이 있는데 마크다운을 쓰는지 물어본다면, 텍스트 기반의 문 서라는 점과 더불어 범용성을 꼽을 것이다. 지금 사용하고 있는 Obsidian뿐만 아니라 Logseq, VSC-foam 등을 활용하면 거의 유사한 환경에서 활용할 수 있다. 또한 Git을 활용한 공유 등에도 뛰어난 점도 있다.