root
/
spring-framework
mirror of https://github.com/spring-projects/spring-framework.git
1
0
Fork 0
Code Issues Actions 2 Packages Projects Releases Wiki Activity
spring-framework/src/docs/asciidoc/index.adoc

29 lines
1.4 KiB
Plaintext
Raw Normal View History

Render reference documentation with Asciidoctor This commit removes docbook from the documentation toolchain and instead makes use of asciidoctor to render the reference documentation in HTML and PDF formats. The main Gradle build has been refactored with the documentation tasks and sniffer tasks extracted to their own gradle file in the "gradle" folder. A new asciidoctor Spring theme is also used to render the HTML5 backend. Issue: SPR-14997
2017-01-05 00:51:58 +08:00
= Spring Framework Reference Documentation
The Spring Framework team and contributors https://github.com/spring-projects/spring-framework/graphs/contributors
:doc-root: https://docs.spring.io
:api-spring-framework: {doc-root}/spring-framework/docs/{spring-version}/javadoc-api/org/springframework
What's new and migrating are prominently featured Before this commit those were burried in the Appendix where few would guess to look. Previously that information was at the top, so it makes sense to point to the Github wiki from the index HTML page. Also a general update of the index page. Since we have recently revised the overview, we can simply point to it and keep it shorter. The section listing now includes more details per section.
2017-10-04 05:55:14 +08:00
Welcome to the Spring Framework reference!
Please read the <<overview.adoc,Overview>> for an introduction including brief history,
design philosophy, where to ask questions, and tips to get started. For information on
what's new, or migrating from a previous version, check the
https://github.com/spring-projects/spring-framework/wiki[Github Wiki].
The reference is divided into several sections:
[horizontal]
<<core.adoc#spring-core,Core>> :: IoC container, Events, Resources, i18n, Validation,
Data Binding, Type Conversion, SpEL, AOP.
<<testing.adoc#testing,Testing>> :: Mock objects, TestContext framework,
Spring MVC Test, WebTestClient.
<<data-access.adoc#spring-data-tier,Data Access>> :: Transactions, DAO support, JDBC,
ORM, Marshalling XML.
<<web.adoc#spring-web,Web Servlet>> :: Spring MVC web framework, WebSocket,
SockJS, STOMP messaging.
<<web-reactive.adoc#spring-webflux,Web Reactive>> :: Spring WebFlux,
WebClient, WebSocket support.
<<integration.adoc#spring-integration,Integration>> :: Remoting, JMS, JCA, JMX, Email,
Tasks, Scheduling, Cache, Dynamic languages.
<<kotlin.adoc#kotlin,Kotlin>> :: Extensions, Bean Definition DSL, WebFlux DSL