준호씨의 블로그

AsciiDoc과의 조우. MarkDown이랑 뭐가 달라? 본문

개발이야기

AsciiDoc과의 조우. MarkDown이랑 뭐가 달라?

준호씨 2020. 5. 18. 23:52

조금 (많이?) 늦은 감이 있지만 AsciiDoc이란 게 있다는 것을 알게 되었습니다. MarkDown과 비슷하게 텍스트로 양식이 있는 문서를 작성할 수 있는 문서 작성 문법이라고 보면 됩니다.

아앗... 그런데 역시 대세는 markdown 이군요.

asciidoc도 혹시 성장 중인 건 아닐까요?

딱히 아닌 거 같습니다. 끝물을 잘못 잡은 건 아닌지 갑자기 걱정되기 시작합니다.

아아니... 심지어 2013년이 마지막 릴리즈입니다.

아아니... MarkDown은 심지어 2004년이 마지막 릴리즈였군요. AsciiDoc이 좀 더 최신(?) 기법이라고 봐도 되지 않을까 합니다. MarkDown이 이렇게 오래된 것이었다니 새삼 놀랍군요.

AsciiDoc에 대해서 글을 쓰고 있지만 사실 저는 아직 AsciiDoc에 대해서 아는 것이 거의 없습니다.

우연히 단톡 방에서 누군가 github에 올려둔 문서가 확장자가 asc라는 것이 특이해서 알게 되었습니다.

github.com/kpug/fpis/blob/master/wiki/chapter15.asc

 

kpug/fpis

Contribute to kpug/fpis development by creating an account on GitHub.

github.com

작성된 문서를 보면 MarkDown으로 작성된 문서나 별반 달라 보이지 않습니다.

MarkDown이었다면 ## 로 headeing 처리를 했을 건데 ==으로 하고 있다는 점이 다릅니다.

코드 구문은 MarkDown이라면 ```로 감쌌을 텐데 ---로 감싸고 있습니다. 그리고 ---위에 [source, scala]라고 적어 주고 있습니다. MarkDown이었다면 ```scala라고 했을 텐데 MarkDown이 좀 더 간결한 느낌이 듭니다.

AsciiDoc은 MarkDown에 비해 무슨 장점이 있을까요?

출처: https://woowabros.github.io/experience/2018/12/28/spring-rest-docs.html

Include기능이 있다고 합니다. MarkDown에서 아쉬웠던 기능 중 하나인데 AsciiDoc에서는 지원하는군요. 문서가 길어질 때 여러 개로 나누고 Include 해볼 수 있겠네요. 특히 소스코드를 별도로 작성해서 실행 가능하면서도 문서에도 들어갈 수 있으니 2중으로 코드를 작성하지 않아도 되는 작점이 생깁니다.

간단히 문서를 하나 작성해 보았습니다.

= AsciiDoc

안녕하세요.

반갑습니다.

--
include::include_test.adoc[]
--

NOTE: 노트

TIP: 팁

IMPORTANT: 중요

CAUTION: 주의

WARNING: 경고

IntelliJ에 asciidoc 플러그인을 설치하면 미리보기가 가능합니다. 다만 include문서는 바로보기는 안되네요.

 

대신 문서를 실행하면 include가 잘 적용됩니다. 문서를 run 하면 브라우저가 실행됩니다.

심지어 다크 테마까지 적용이 되어 있습니다.

참고로 github에서도 AsciiDoc문서의 미리보기는 제공하고 있지만 include기능 까지는 제공해 주고 있지는 않습니다.

github에서 본 보습

워낙 MarkDown이 대세이긴 하지만 AsciiDoc도 꽤 쓸만한 물건 같습니다. MarkDown이 AsciiDoc의 좋은 기능들을 흡수해 주면 좋겠지만 오랜 기간 기능이 개선되지 않은 것으로 보아 더 이상 변화가 있을지는 의문입니다. AsciiDoc도 마찬가지이고요. 혹시 제가 모르는 더 좋은 방식이 문서 작성 언어가 나왔으려나요?

아무튼 한동안 AsciiDoc으로 문서를 좀 써보려고 합니다. 쓰다 보면 써도 괜찮은 물건인지 아닌지 알게 되겠죠.

0 Comments
댓글쓰기 폼