Maven生成Spring官方文档.adoc

Maven生成Spring官方文档

Table of Contents

• 介绍
• HTML文档生成
  • 导入依赖
  • 创建目录
  • 编写AsciiDoc
  • 执行命令
• 带目录的HTML页面生成
  • 创建首页
  • 执行命令
  • 查看页面
• 替换logo
• 源码地址

介绍

通过该插件可以将 Asciidoctor 转换成 Spring 风格的HTML页面

HTML文档生成

导入依赖

<plugin>
	<groupId>org.asciidoctor</groupId>
	<artifactId>asciidoctor-maven-plugin</artifactId>
	<version>3.0.0</version>
	<executions>
		<execution>
			<id>generate-html-documentation</id>
			<phase>prepare-package</phase>
			<goals>
				<goal>process-asciidoc</goal>
			</goals>
			<configuration>
				<backend>spring-html</backend>
			</configuration>
		</execution>
	</executions>
	<dependencies>
		<dependency>
			<groupId>io.spring.asciidoctor.backends</groupId>
			<artifactId>spring-asciidoctor-backends</artifactId>
			<version>0.0.7</version>
		</dependency>
	</dependencies>
</plugin>

创建目录

使用 Asciidoctor Maven 插件来生成文档

AsciiDoc 源代码默认放在 src/docs/asciidoc

因此，需要我们创建目录 src/docs/asciidoc

编写AsciiDoc

在 src/docs/asciidoc 新建文档 test.adoc 文档里面随便写一段话

执行命令

在 根目录 执行命令 mvn prepare-package 转换成 HTML 页面

默认生成位置为 根目录/target

找到 test.html 并打开

带目录的HTML页面生成

创建首页

在 src/docs/asciidoc 新建 index.adoc 文档里面填写如下内容

请查看Asciidoctor语法

执行命令

略，同上文

查看页面

找到 index.html 打开

替换logo

替换logo，我提供两种思路：
1.修改maven plugin源码，修改完之后打包并替换掉之前的插件
2.直接修改生成的HTML页面样式[本文采用这种方式]

源码地址

本项目已集成，直接使用即可