文档建议反馈控制台
首页
学习
活动
专区
工具
TVP
最新优惠活动
文章/答案/技术大牛
发布
精选内容/技术社群/优惠产品,尽在小程序
立即前往

使用Maven从AsciiDoc生成PDF，并将其放在不同的模块中。

Maven是一个Java项目管理和构建工具，AsciiDoc是一种轻量级标记语言，用于编写技术文档。通过使用Maven插件可以将AsciiDoc文档转换为PDF格式，并将其放置在不同的模块中。

要实现这个目标，可以按照以下步骤进行操作：

  1. 确保你已经安装了Maven，并且已经配置好了环境变量。
  2. 在Maven项目的根目录下创建一个名为"docs"（或者其他你喜欢的名称）的文件夹，用于存放AsciiDoc文档。
  3. 在"docs"文件夹中创建一个名为"index.adoc"的AsciiDoc文档，作为主文档。
  4. 在主文档中，你可以使用AsciiDoc的语法编写内容，并且可以包含其他的AsciiDoc模块。
  5. 在Maven项目的根目录下的pom.xml文件中，添加以下插件配置：
代码语言：txt
复制
<build>
    <plugins>
        <plugin>
            <groupId>org.asciidoctor</groupId>
            <artifactId>asciidoctor-maven-plugin</artifactId>
            <version>1.5.8</version>
            <executions>
                <execution>
                    <id>generate-pdf</id>
                    <phase>compile</phase>
                    <goals>
                        <goal>process-asciidoc</goal>
                    </goals>
                    <configuration>
                        <backend>pdf</backend>
                        <doctype>book</doctype>
                        <attributes>
                            <toc>left</toc>
                        </attributes>
                    </configuration>
                </execution>
            </executions>
        </plugin>
    </plugins>
</build>

这个插件配置指定了将AsciiDoc文档转换为PDF格式，并在编译阶段执行。

  1. 在命令行中进入到Maven项目的根目录，并执行以下命令：
代码语言：txt
复制
mvn compile

这个命令会触发Maven执行编译阶段，并且会执行AsciiDoc转换为PDF的操作。

  1. 完成后，在Maven项目的根目录下的"target"文件夹中会生成一个名为"generated-docs"的文件夹，其中包含了生成的PDF文件。
  2. 如果你想将生成的PDF文件放置在不同的模块中，可以在每个模块的pom.xml文件中添加以下插件配置：
代码语言：txt
复制
<build>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-resources-plugin</artifactId>
            <version>3.2.0</version>
            <executions>
                <execution>
                    <id>copy-pdf</id>
                    <phase>package</phase>
                    <goals>
                        <goal>copy-resources</goal>
                    </goals>
                    <configuration>
                        <outputDirectory>${project.build.directory}/pdf</outputDirectory>
                        <resources>
                            <resource>
                                <directory>${project.basedir}/../target/generated-docs</directory>
                                <includes>
                                    <include>*.pdf</include>
                                </includes>
                            </resource>
                        </resources>
                    </configuration>
                </execution>
            </executions>
        </plugin>
    </plugins>
</build>

这个插件配置指定了将生成的PDF文件复制到指定的模块中的"pdf"文件夹下。

  1. 在命令行中进入到每个模块的根目录，并执行以下命令：
代码语言：txt
复制
mvn package

这个命令会触发Maven执行打包阶段，并且会执行将PDF文件复制到指定模块的操作。

完成以上步骤后，你就可以使用Maven从AsciiDoc生成PDF，并将其放置在不同的模块中了。这样可以方便地管理和分发生成的PDF文档。

请注意，以上答案中没有提及腾讯云相关产品和产品介绍链接地址，因为这些信息需要根据具体的需求和场景来选择，可以根据实际情况在腾讯云官方网站或者文档中查找相关产品和介绍。

相关搜索:Python:如何从字符串生成单词列表，并根据单词的索引将其保存在文本文件中？从字符串中删除货币符号，并使用Javascript中的单行将其转换为数字从目录中提取pdf并使用pdf2image将图像输出到不同的目录使用maven从表中读取键值并更新属性文件中的占位符使用maven在不同的环境中运行RestAssured冒烟测试，并使用它自己的唯一API密钥作为头文件。使用wicked_pdf gem显示从HTML内容生成的PDF中的特殊字符使用从Windows ID找到的数据，并通过Powershell将其放入电子邮件中在不同模块的初始化中调用“self.init”或将其赋值给“self”之前，使用了“self”错误复制-使用PDFBox从生成的PDF中粘贴文本会导致垃圾如何从dataTables中获取不同的值，并使用JS对总的特定字段求和
相关搜索:
页面内容是否对你有帮助？
有帮助
没帮助

相关·内容

怎么将swagger API导出为HTML或者PDF

> 版本我们用的是最新的1.3.7. target/docs/asciidoc/generated 是生成的ASCIIDOC的目标地址，我们会在后面将其转换为...运行下面命令生成asciidoc： mvn swagger2markup:convertSwagger2markup asciidoctor-maven-plugin 有了asciidoc，我们使用asciidoctor-maven-plugin...这意味着你可以写你的文档中的任何语言，使用UTF-8编码的文件，并期望Asciidoctor到文本正确转换。但是，您可能会注意到PDF中缺少某些语言的某些字符，例如中文。...如果您使用非拉丁语书写，则需要使用专门的主题来提供必要的字体。例如，以从写在CJK语言文档的PDF如中国，你需要使用一个CJK主题。...很简单，使用KaiGenGothicTW字体即可。 PDF中文主题在maven中的使用 那么有了命令行，我们怎么在maven中使用呢？

4.2K10

Asciidoctor Maven插件使用

在项目应用中，我们会写很多文档去传递我们的设计思想、开发经验、采坑经历等等。使用Asciidoc的格式对非技术人员就不是那么的友好，或者说传递性、通用性与PDF和网页相比就差很多了。...在JVM项目中可以使用Maven的插件方式将.adoc文件格式转化为PDF、HTML、EPUB等文件格式。...生成的HTML可以使用Http Server或者Nginx等服务进行部署，甚至可以使用Jenkins进行自动化部署。...由于PDF格式插件没有安装中文字体，生成的PDF格式上会存在缺失，上方的fonts和themes可以对PDF的生成格式进行自定义，有时候为了方便，可以将其与asciidoctorj-pdf源码进行合并...常见问题 在生成PDF的时候，可能code部分会存在很多空格的问题，一般产生这样的问题不是字体问题，而是编写格式有问题，可以选择将符号去掉。

1.4K30

Swagger 接口管理和文档导出

String uris = System.getProperty("io.swagger.json.uris"); //获取插件中配置的每个json文件的名称，名称可配置多个...配置插件执行 生成 pdf 和 html 格式的接口文档 由于compile配置，接口分组id不同，调整参数执行mvn compile(或在idea中的maven project...文件重命名分类存放 执行mvn compile、mvn test分别生成html和pdf的接口文档，文档分类重命名放到指定文件夹（此处对maven生命周期不了解的同学请自行百度） maven 插件重命名文件并移动...--由asciidoc生成pdf：该段插件配置平时注释，只在需要生成文档时解开注释，且前文的操作(swagger.json生成、adoc文件生成)务必已执行完--> ...+asciidoctorj生成html和pdf文档并解决asciidoctorj生成的pdf文件中文显示不全问题（maven方式及java代码方式） maven打包加时间戳方法总结

2K10

Spring Boot 2.X(十五)：集成 Swagger2 开发 API 文档（在线+离线）

而手写 api 文档的话有诸多痛点： 文档更新的时候，需要再次发送给对接人 接口太对，手写文档很难管理 接口返回的结果不明确 不能直接在线测试接口，通常需要使用工具，如 postman 等 Swagger...Swagger 简介 Swagger 是一个规范和完整的框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。总体目标是使客户端和文件系统作为服务器以同样的速度来更新。...文件的方法，参数和模型紧密集成到服务器端的代码，允许API来始终保持同步。 官网：https://swagger.io Swagger 使用 1.相关依赖 <!...@Api 用于类，表示标识这个类是swagger的资源。属性如下： tags 表示说明，tags如果有多个值，会生成多个列表 value 表示说明，可以使用tags替代 2..../docs/asciidoc/generated")); } /** * 生成AsciiDocs格式文档,并汇总成一个文件 *

2.3K20

重学Spring系列之Swagger2.0和Swagger3.0

swagger2 使用Swagger2Markup实现导出API文档 生成AsciiDoc 通过Java代码来生成 通过Maven插件来生成 可以参考的文章 Swagger3-即OpenAPI使 整合springdoc-openapi...生成AsciiDoc 生成AsciiDoc的方式有两种： 通过Java代码来生成 第一步：编辑pom.xml增加需要使用的相关依赖和仓库 io.github.swagger2markup...，可以是这样的URL形式，也可以是符合Swagger规范的String类型或者从文件中读取的流。...---- 通过Maven插件来生成 除了通过上面编写Java代码来生成的方式之外，swagger2markup还提供了对应的Maven插件来使用。...spring boot2.0+swagger自动生成PDF和HTML格式的API文档 swagger+asciidoctor 导出PDF中文缺失乱码问题解决 ---- Swagger3-即OpenAPI

1.9K10

【译】Spring 官方教程：使用 Restdocs 创建 API 文档

构建可执行的 JAR 文件 可以从 Gradle 或者 Maven 的命令行运行此程序，也可以构建一个单独的可执行的JAR文件，此文件包含了应用程序所有必需的依赖、类以及资源。...由于应用程序存在不同的开发周期，也会部署于不同的环境，这种方法使应用程序的转移、版本管理、以及发布都变得更加简单。 如果使用 Gradle，可以使用 ./gradlew bootRun 运行程序。...为了让生成的代码段运行，创建一个文件， src/main/asciidoc/index.adoc 并根据需要添加代码片段。...Gradle 中 asciidoctor 源的默认位置是 src/doc/asciidoc。我们只需要设置， sourceDir 因为我们更改了位置以匹配 Maven 的默认值。 总结 恭喜！...你刚刚开发了一个 Spring 应用程序，并使用 Spring Restdocs 生成文档。你可以将你创建的 HTML 文档发布到静态网站，或将其打包为应用程序本身所用。

5.2K70

markdown 替代品 asciidoc 介绍

AsciiDoctor AsciiDoctor 是 AsciiDoc 的 Ruby 实现，也是一个工具链，实现了 AsciiDoc 对 HTML5/DocBook/EPUB/PDF/MOBI 的转换（有的需要借助第三方工具例如...AsciiDoctor 是一个很宏伟的项目，还有很多子项目在开发中，例如我比较关注的 Asciidoctor PDF 和 Asciidoctor EPUB3，这两个项目用于去掉现有工具链中对 DocBook...Asciidoctor 会读取并处理用 AsciiDoc 语法写的文件，然后将解析出来的解析树参数交给内置的转化器去生成 HTML 5，DocBook 5 或帮助手册页面输出。...下面的命令将 README.adoc 文件转化为 HTML，并且保存到同一目录下的 README.html 文件中。 生成的 HTML 文件名源自源文件名，只是将其扩展名改为了 `.html`。..._ Asciidoctor 支持自定义转化器，它可以操作从待处理文件到生成文档整个环节。 一个简单的、细微地自定义输出的方式是使用模板转化器。

1.7K20

分享：手把手生成漂亮的静态文档说明页

总体步骤 •整合Swagger，生成Swagger描述端点 /v2/api-docs•使用 swagger2markup-maven-plugin ，将 /v2/api-docs 生成ASCIIDOC文件...；•使用 asciidoctor-maven-plugin ，将ASCIIDOC文件转换成HTML；•部署 整合Swagger TIPS Swagger的使用非常简单，本文不展开探讨了，各位看官自行百度一下用法吧...插件的作用是读取 http://localhost:8080/v2/api-docs 的信息，生成ASCIIDOC文档。...这款插件还有很多使用姿势，详见 https://github.com/Swagger2Markup/swagger2markup-maven-plugin[2] 生成HTML 下面，只需要将ASCIIDOC...插件同样也有很多姿势，详见：https://github.com/asciidoctor/asciidoctor-maven-plugin[3] 生成的文件在 src/docs/asciidoc/html

1.1K40

Elastic进阶教程：生成离线pdf文档

前言之前写过一篇如何生成离线官方文档的文章，但也有社区伙伴反馈说，是不是能够导出一个pdf格式的离线文档。将html转换成pdf，网上有非常多的工具。...图片因此，要想将所有内容都导出到一个pdf文件中，需要解决核心的问题是把原先文档的book的组织形式，变成一个“大宽表” —— 把内容都组织在一个页面上，才能够利用工具将其转换。...HTML格式文档的构建方法：Elastic Stack中，不同的软件、不同的版本，其文档的路径和依赖的资源有不同，因此，调用的命令也不一样。...将单页html转换成pdf，我们可以使用很多现成的工具。...pdf如下：图片总结该方法不仅可以用于生成elastic官方文档的pdf版本，原则上，适用于所有以asciidoc方式编码的文档，对于pdf文档有需求的朋友，可以尝试以此方式为book形式的web内容生成

3.5K122

在gradle中构建java项目

简介 之前的文章我们讲到了gradle的基本使用，使用gradle的最终目的就是为了构建java项目。今天本文将会详细的讲解如何在gradle中构建java项目。...两者在build.gradle中的不同在于plugins的不同，application的plugin是： plugins { id 'application' } 而library的plugin...{ implementation project(':shared') } 编译代码 一般情况下你的源代码需要放在src/main/java 目录下，测试代码需要放在src/test/java...我们需要将这些配置文件拷贝到特定的目标目录中。 默认情况下，gradle会拷贝src/[sourceSet]/resources 中的文件到目标文件夹中。...它支持标准的javadoc，也支持其他类型的文档，比如说Asciidoc，我们看一个生成Asciidoc的例子： configurations { asciidoclet } dependencies

1.3K31

在gradle中构建java项目

简介 之前的文章我们讲到了gradle的基本使用，使用gradle的最终目的就是为了构建java项目。今天本文将会详细的讲解如何在gradle中构建java项目。...两者在build.gradle中的不同在于plugins的不同，application的plugin是： plugins { id 'application' } 而library的plugin...{ implementation project(':shared') } 编译代码 一般情况下你的源代码需要放在src/main/java 目录下，测试代码需要放在src/test/java...我们需要将这些配置文件拷贝到特定的目标目录中。 默认情况下，gradle会拷贝src/[sourceSet]/resources 中的文件到目标文件夹中。...它支持标准的javadoc，也支持其他类型的文档，比如说Asciidoc，我们看一个生成Asciidoc的例子： configurations { asciidoclet } dependencies

1.6K30

在gradle中构建java项目

简介 之前的文章我们讲到了gradle的基本使用，使用gradle的最终目的就是为了构建java项目。今天本文将会详细的讲解如何在gradle中构建java项目。...两者在build.gradle中的不同在于plugins的不同，application的plugin是： plugins { id 'application' } 而library的plugin...{ implementation project(':shared') } 编译代码 一般情况下你的源代码需要放在src/main/java 目录下，测试代码需要放在src/test/java...我们需要将这些配置文件拷贝到特定的目标目录中。 默认情况下，gradle会拷贝src/[sourceSet]/resources 中的文件到目标文件夹中。...它支持标准的javadoc，也支持其他类型的文档，比如说Asciidoc，我们看一个生成Asciidoc的例子： configurations { asciidoclet } dependencies

1.6K51

Swagger生成Javadoc

swagger2markup 使用MAVEN插件生成AsciiDoc文档 使用MAVEN插件生成HTML 下节预告 Swagger生成JavaDoc ---- 在日常的工作中，特别是现在前后端分离模式之下...生成离线文档 为了不让我们做痛苦的工作，我们既然已经在代码中添加了那么多的说明信息，是否有一种方式可以帮助我们来生成一份离线的文档呢？答案是肯定的。...源码传送门 documents传送门 Swagger2Markup它主要是用来将Swagger自动生成的文档转换成几种流行的格式以便离线使用 格式：AsciiDoc、HTML、Markdown、Confluence...使用MAVEN插件生成AsciiDoc文档 在mscx-shop-api\pom.xml中加入以下依赖代码： <!...adoc文件生成好了，那么我们使用它来生成html吧 使用MAVEN插件生成HTML 在mscx-shop-api\pom.xml中加入以下依赖代码： <!

77820

AsciiDoc 简介

Markdown 是现在最流行的轻量级标记语言，Github、Stack Overflow、Smashing Magazine 等网站都使用 Markdown。...Markdown 格式简单，纯文本具有很好的可读性。但它对复杂格式（例如表格、图片标题）支持不够，也没有预留扩展语法，不同网站各自扩展产生了很多方言。...Markdown 通过自行扩展语法或者使用 HTML 可以实现这些格式，但前者造成文档不通用的问题，后者则直接把展示结构硬编码到了文档中，将来修改会很麻烦。.../DocBook/EPUB/PDF/MOBI 的转换（有的需要借助第三方工具例如 Kindlegen）。...AsciiDoctor 是一个很宏伟的项目，还有很多子项目在开发中，例如我比较关注的 Asciidoctor PDF 和 Asciidoctor EPUB3，这两个项目用于去掉现有工具链中对 DocBook

2K00
点击加载更多

扫码

添加站长 进交流群

领取专属 10元无门槛券

手把手带您无忧上云

扫码加入开发者社群

相关资讯

热门标签

更多标签

活动推荐

    运营活动

    活动名称
    广告关闭

    腾讯云开发者

    扫码关注腾讯云开发者

    扫码关注腾讯云开发者

    领取腾讯云代金券

    热门产品

    热门推荐

    更多推荐

    Copyright © 2013 - 2024 Tencent Cloud. All Rights Reserved. 腾讯云 版权所有

    深圳市腾讯计算机系统有限公司 ICP备案/许可证号：粤B2-20090059 深公网安备号 44030502008569

    腾讯云计算（北京）有限责任公司 京ICP证150476号 | 京ICP备11018762号 | 京公网安备号11010802020287

    领券