시작
markdown의 시대
이 계통에 발을 담고 있다보면, 마크다운을 알지 못하기도 힘들다.
개발 업무에 종사하다보니, 가이드, 메뉴얼 등등을 작성할 일은 끊이지 않았다. 내용을 갱신하는 일도 마찬가지다.
예전에는 문서 작업을 할 때마다, 묵직~한 아래아 한글, MS Word등 문서 작성 프로그램 열리는걸 기다리고 했다.
누락된 마침표 하나를 채우기 위해 편집기를 여는 기다림은 나의 몫이었고 감안해야했다.
markdown은 이러한 문서 작업을 단순한 텍스트를 이용해서 빠르게 작성, 수정하고 괜찮은 결과물을 얻기에 좋은 선택이다.
다만, markdown은 변환을 거쳐야 미려한 문서가 나오기에 미리보기 도구나, 변환 도구를 설치하고 설정해서 사용해야한다.
내 경우 VSCode를 기본 편집기로 사용한다. 기본 markdown 미리보기가 포함되어 있으나, 기능이 약간 아쉬워서 markdown preview enhanced 플러그인을 사용해왔다.
그리고 markdown 파일 자체는 git scm을 이용해서 관리해왔는데, 아쉬운 경우가 있었다.
markdown 문서가 개발 소스(git) 기준으로 관리되다보니까 개발 프로젝트에 넣어 관리하지 않을 markdown문서들의 위치가 애매해지고, 편집기로 열기가 번잡해지는 경향이있어 아쉬웠다.
obsidian이 이를 해소시켜주지 않을까 해서 설치하고 설정해보기로 했다.
설치
요즘 소프트웨어 답게, 설치가 어려울 것은 없다.
웹 사이트에 접속해서 다운 누르고 설치 프로그램 실행하고, 다음 확인 뭐 이런거..
설치 - 플러그인
나는 개발 업무에 필요한 UML 그리기용도로 plantuml 이라는 형식을 사용한다
obsidian은 비슷한 역할을 하는 mermaid라는 것을 내장해서 대용으로 사용 할 수 있지만, 기존 다이어그램과 호환성을 위해 plantuml 지원이 필요하다.
다행히도 plantuml 플러그인을 찾을 수 있었다.
아래의 링크인데, 직접 받을 필요는 없고, 가이드 확인을 위해 읽어볼 필요는 있었음
https://github.com/joethei/obsidian-plantuml/
GitHub - joethei/obsidian-plantuml: Generate PlantUML Diagrams inside Obsidian.md
Generate PlantUML Diagrams inside Obsidian.md. Contribute to joethei/obsidian-plantuml development by creating an account on GitHub.
github.com
settings -> Community plugins에 들어가 Safe mode를 꺼야한다 (외부 플러그인을 설치하려면 어쩔 수 없다 ㅠㅠ)
Browse 버튼을 눌러 plantuml을 입력하거나 목록에서 찾으면 아래와 같이 플러그인 정보가 표시되고, 설치를 수행 할 수 있다.
조금 독특한건 플러그인을 설치했다고 바로 사용 상태가 되지 않았다.
그래서 다시 플러그인을 찾아서 Enable을 눌러주었다.
상세설정
회사 업무에 사용할 것이라 확률은 희박하지만 내부 정보가 유출될 가능성을 최소화 시켜야한다. (직업병?)
plantuml의 기본 동작 방식은 plantuml 서식에 맞게 만들어진 문서를 plantuml 공식 서버에 전송하고, 그 결과를 그림 파일로 전달 받아 보여주는 형태이다.
plantuml 공식 홈페이지가 내용을 유출 할 일는 없겠지만, 보안이란 신뢰하는 개체가 적을 수록 좋다.
설치된 플러그인 목록에 보면 Plantuml이 추가 되어 있음을 확인 할 수 있고, 플러그인의 설정 아이콘을 눌러보자.
두가지 선택지가 있다, plantuml (공식, 사설) 서버를 이용하거나, plantuml java API를 이용하는 방법
당연히 최고의 보안을 위해 Local JAR 방식을 선택하고, 설정했는데..
이 플러그인의 구조적인 문제인지, 심하게 느리다(수정하면 생성중이라는 메시지가 뜨고, 한 3초 기다렸나? 안나오는 줄알고 새로고침을 찾고 있었음). 그러므로 탈락!
다행스럽게도, 애초에 보안을 생각해서 내부에 설치해둔 Local plantuml 서버가 있어서 Server URL에 설정해주었다.
성능은 쓸만한 편으로, 수정하자마자 바로 깜빡이면서 갱신됨을 확인했다.
이제 사용해보고, 적당한 시점에 후기를 남겨봐야겠다.