본문 바로가기

반응형

AsciiDoc

(3)
Antora 사용해 보기 Spring Framework 문서가 antora로 제공된 지 꽤 시간이 지났는데 Spring Boot 문서도 이번 3.3.0부터 antora로 변경되었다.https://antora.org/요즘 오픈 소스 사이트 문서들을 보면 antora로 빌드하는 경우가 상당히 많아 antora 사용 방법에 대해 살펴보았다.Antora 소개Antora는 asciidoc 기반 문서를 기반으로 site 문서 (웹 기반 문서)를 생성하는 도구이다.https://www.algolia.com/antora를 사용하면 여러 git repository에 위치한 adoc 문서들을 취합하고 템플릿을 사용하여 하나의 통일된 스타일의 site 문서로 구성할 수 있다.git repository의 branch 단위의 문서를 가져와 버전별 문서..
Asciidoc 문서 작성을 위한 프로젝트 경로 설정 팁 eclipse의 AsciiDoctor Editor를 사용하면서 설정한 내용임 asciidoc 문서 작성을 위해 프로젝트를 설정하면서 예제 소스를 include 하기 위해 다음과 같이 설정하였다. org.asciidoctor asciidoctor-maven-plugin ${asciidoctor.maven.plugin.version} org.springframework.restdocs spring-restdocs-asciidoctor ${spring-restdocs.version} asciidoc-to-html prepare-package process-asciidoc html5 coderay true src/main/resources/static ${java.version} ${spring-restdocs..
Spring Rest Docs 사용해보기 Spring Rest Docs 2.0.5.RELEASE 기준으로 작성된 글 maven 빌드 기준 설명임 Spring REST Docs 소개 Sprig Rest Docs 문서 Spring REST Docs Document RESTful services by combining hand-written documentation with auto-generated snippets produced with Spring MVC Test. docs.spring.io Spring Rest Docs는 asciidoc 개발 문서 작성에 spring web 요청/응답 결과에 대한 문서 자동화를 지원해주는 라이브러리이다. 예전에 spring boot + swagger기반의 라이브러리인 springfox swagger를 사용해서..

반응형