겸쨔

[spring-rest-docs] adoc 파일 pdf 변환. asciidoctor-web-pdf 본문

spring/spring-rest-docs

[spring-rest-docs] adoc 파일 pdf 변환. asciidoctor-web-pdf

겸쨔 2024. 7. 26. 10:06
반응형

안녕하세요.

발주처에서 spring rest docs로 작성한 api 문서를 pdf로 변환 해달라고 하네요.

간단하기 때문에 잘 보고 해보시면 금방 하실 수 있으세요.

 

pdf 파일로 변환 해주는 asciidoctor-web-pdf 라는 라이브러리를  사용할거에요.

해당 라이브러리는 Ruby로 구성되어 있는 것도 있는데, 전 귀찮아서 다른 방법을 찾아 봤어요.

 

찾아보니 npm으로도 받을 수 있더라구요?

npm이 있는데 굳이 ruby로 할 필요를 못 느꼈어요.

 

우선 adoc이 있는 디렉토리로 들어옵니다.

저 같은 경우에는 아래와 같은 경로에요.

/src/docs/asciidoc

 

 

 

디렉토리로 들어 오셨으면 아래 명령어를 쳐서 install해요.

 npm i -g @asciidoctor/core asciidoctor-pdf

 

아래 명령어로 잘 설치 되었는지 확인해요.

asciidoctor-web-pdf --version

 

잘 설치 되었다면 아래 명령어로 바로 변환 해봐요.

asciidoctor-web-pdf ./index.adoc

 

이렇게 하면 pdf로 잘 변환 되어 나와요.

 

끝이에요. 간단하죠?

 

반응형

'spring > spring-rest-docs' 카테고리의 다른 글

[spring-rest-docs] Unresolved directive in  (0) 2024.07.26