파란하늘의 지식창고
반응형

Spring Framework 문서를 보다 보면 5.2.0.RELEASE 이후 많은 부분이 바뀌었음을 알 수 있다.

한눈에 보이는 변경점은 문서 스타일의 변경이다.

이전 버전이 문서의 경우 spring의 스타일이 추가되었지만 기본적으로 asciidoctor 문서 스타일과 비슷하다.

docs.spring.io/spring/docs/5.1.16.RELEASE/spring-framework-reference/core.html

5.2.0.RELEASE 이후 문서는 아래와 같다.

docs.spring.io/spring/docs/5.2.0.RELEASE/spring-framework-reference/core.html

변경된 스타일의 asciidoctor 문서로 만드는 방법은 아래 글을 참고하면 된다.

2020/06/12 - [Study/Java] - spring reference doc 문서는 어떻게 만들어질까?

 

spring reference doc 문서는 어떻게 만들어질까?

Spring은 모든 프로젝트가 reference 문서를 제공하고 있다. 이 문서가 어떻게 만들어지는지 궁금할 사람들을 위해 소개해본다. 다만 자세한 사용법을 설명하기엔 양이 너무 많기 때문에 링크를 통��

luvstudy.tistory.com

문서 왼쪽에 위치한 TOC의 자동 expandable/collapsable 기능

이 기능은 이미 이전부터 있었다.

폰트 크기가 작아져서 인지 좀 더 문서 메뉴를 파악하기 쉬워졌다.

예제 코드의 Block switch 지원

예제가 Java / Kotlin으로 언어별 예제를 제공하게 변경되었다.

아직 Spring Framework Documentation에만 예제가 제공되고 있고 boot나 data 쪽은 없다.

spring-asciidoctor-extensions

예제의 block switch 사용을 하려는 경우 Spring의 spring-asciidoctor-extensions를 쓰면 된다.

https://github.com/spring-io/spring-asciidoctor-extensions

 

spring-io/spring-asciidoctor-extensions

Asciidoctor Extensions developed by the Spring team - spring-io/spring-asciidoctor-extensions

github.com

이외에도 spring-asciidoctor-extensions를 쓰면 configprop macro를 사용할 수 있고 properties에 대해 validation도 가능하다.

 

반응형
profile

파란하늘의 지식창고

@Bluesky_

도움이 되었다면 광고를 클릭해주세요