</groupId> <artifactId>asciidoctor-maven-plugin</artifactId> <version --https://github.com/asciidoctor/asciidoctor-maven-examples--> <! --https://github.com/asciidoctor/asciidoctor-maven-plugin/blob/master/README_zh-CN.adoc--> <! </groupId> <artifactId>asciidoctor-maven-plugin</artifactId> <version 参考资料 Example Asciidoctor插件中文文档 Asciidoctor-PDF 中文乱码问题解决方案
AsciiDoctor 是一个很宏伟的项目,还有很多子项目在开发中,例如我比较关注的 Asciidoctor PDF 和 Asciidoctor EPUB3,这两个项目用于去掉现有工具链中对 DocBook 示例一: https://raw.githubusercontent.com/asciidoctor/asciidoctor/master/README-zh_CN.adoc = Asciidoctor }[在 Mac OS X 安装 Asciidoctor ] [#usage] == 使用 如果成功安装 Asciidoctor,则在可执行程序路径中,`asciidoctor` 就可用了。 f=tweets&q=%23asciidoctor[#asciidoctor] 来加入话题 或 https://twitter.com/asciidoctor[@asciidoctor] at并提醒我们 https://github.com/asciidoctor/asciidoctor-vscode
> Could not determine artifacts for org.asciidoctor.convert:org.asciidoctor.convert.gradle.plugin /org.asciidoctor.convert.gradle.plugin/2.3.0/org.asciidoctor.convert.gradle.plugin-2.3.0.jar' /convert/org.asciidoctor.convert.gradle.plugin/2.3.0/org.asciidoctor.convert.gradle.plugin-2.3.0.jar] :Access denied to: http://repo.spring.io/plugins-release/org/asciidoctor/convert/org.asciidoctor.convert.gradle.plugin /convert/org.asciidoctor.convert.gradle.plugin/2.3.0/org.asciidoctor.convert.gradle.plugin-2.3.0.jar]
运行下面命令生成asciidoc: mvn swagger2markup:convertSwagger2markup asciidoctor-maven-plugin 有了asciidoc,我们使用asciidoctor-maven-plugin Asciidoctor用Ruby编写,可在所有主要操作系统上运行。 Asciidoctor提供了一个asciidoctor-maven-plugin,可以方便的在maven环境使用。 安装asciidoctor-pdf: gem install asciidoctor-pdf --pre 转换pdf: asciidoctor -r asciidoctor-pdf -b pdf basic-example.adoc PDF的中文展示 Asciidoctor可以处理全范围的UTF-8字符的字符集。 如何安装: gem install asciidoctor-pdf-cjk-kai_gen_gothic 下载字体: asciidoctor-pdf-cjk-kai_gen_gothic-install
使用asciidoctor或者org.asciidoctor.maven插件生成pdf文件时,会出现中文乱码。使用以下方法,不需要安装asciidoctor软件,也不需要修改字体设置。 下载代码 git clone https://github.com/cloudedi/asciidoctor-pdf-cjk.git 将创建好的asciidoc文件放在asciidoctor-pdf-cjk
>${project.basedir}/src/docs/asciidoc</asciidoctor.input.directory> <generated.asciidoc.directory >${project.build.directory}/asciidoc/html</asciidoctor.html.output.directory> <asciidoctor.pdf.output.directory >${project.build.directory}/asciidoc/pdf</asciidoctor.pdf.output.directory> <swagger.output.zip </groupId> <artifactId>asciidoctor-maven-plugin</artifactId> <version>1.5.3 然后将文件夹压缩给需要接口的人即可 REFRENCES asciidoctor-pdf 【github】 asciidoctor-maven-plugin 【github】 通过swagger2markup
整合Swagger,生成Swagger描述端点 /v2/api-docs•使用 swagger2markup-maven-plugin ,将 /v2/api-docs 生成ASCIIDOC文件;•使用 asciidoctor-maven-plugin HTML 下面,只需要将ASCIIDOC转换成html就OK了,在pom.xml中添加如下内容: <build> <plugins> <plugin> <groupId>org.asciidoctor </groupId> <artifactId>asciidoctor-maven-plugin</artifactId> <version>1.5.6</version> sectlinks> <sectanchors></sectanchors> </attributes> </configuration> </plugin> asciidoctor-maven-plugin 插件同样也有很多姿势,详见:https://github.com/asciidoctor/asciidoctor-maven-plugin[3] 生成的文件在 src/docs/asciidoc/html
详细的语法说明可以看这份文档:[http://asciidoctor.org/docs/asciidoc-syntax-quick-reference/](http://asciidoctor.org/ ## AsciiDocto [AsciiDoctor](http://asciidoctor.org/) 是 AsciiDoc 的 Ruby 实现,也是一个工具链,实现了 AsciiDoc 对 HTML5 相比原版 Python 实现,AsciiDoctor 作了以下改进: * 添加模板引擎,可以用 Ruby 的模板语言(例如 erb)自定义输出格式。 AsciiDoctor 是一个很宏伟的项目,还有很多子项目在开发中,例如我比较关注的 Asciidoctor PDF 和 Asciidoctor EPUB3,这两个项目用于去掉现有工具链中对 DocBook 因为有 AsciiDoctor 这样设计精良的实现,我才决定把精力放到 AsciiDoc 上。 ## 编辑器 轻量级标记语言不依赖编辑器,但好的编辑器会让写作过程更愉快。
curl-request.adoc └── http-request.adoc └── http-response.adoc 默认情况下,snippets是Asciidoctor 需要使用asciidoctor-maven-plugin插件,在其pom文件加上: <plugin> <groupId>org.asciidoctor</groupId> <artifactId >asciidoctor-maven-plugin</artifactId> <executions> <execution> <id>generate-docs
很多标注着 仅 _Asciidoctor 可用 的特性通过 Asciidoctor 项目提供的 AsciiDoc 配置文件 也可以在传统的 AsciiDoc Python 处理器中使用。 | AsciiDoc 语法快速参考 https://asciidoctor.cn/docs/asciidoc-syntax-quick-reference/
使用代码片段 要使用生成的代码片段,你希望在项目中有一些 Asciidoctor 的内容,然后在构建时添加代码片段。 其主要特点是它包含 2 个片段,使用 Asciidoctor include 指令(冒号和尾部括号告诉解析器在这些行上执行特殊操作)。 请注意,包含的片段的路径 {snippets}表示为占位符 - 是Asciidoctor 中的一个“属性”。 classpath("org.asciidoctor:asciidoctor-gradle-plugin:1.5.3") } } ... apply plugin: 'org.asciidoctor.convert ') } Asciidoctor Gradle 插件不在 Maven Central 中,所以你还必须添加 jcenter() 到 Gradle 中的 buildscipt 依赖项。
一、ADoc和markdown比较 ADoc和markdown比较 https://docs.asciidoctor.org/asciidoc/latest/asciidoc-vs-markdown/ 二、说明文档 说明文档 https://asciidoctor.org/docs/#the-basics 三、IDEA插件(AsciiDoc) 一、下载相关软件 下载软件 二、将软件设置为中文格式
curl-request.adoc └── http-request.adoc └── http-response.adoc 默认情况下,snippets是Asciidoctor 需要使用asciidoctor-maven-plugin插件,在其pom文件加上: <plugin> <groupId>org.asciidoctor</groupId> <artifactId >asciidoctor-maven-plugin</artifactId> <executions> <execution> <id>generate-docs
</plugin> <plugin> <groupId>org.asciidoctor </groupId> <artifactId>asciidoctor-maven-plugin</artifactId> <dependency> <groupId>org.asciidoctor</groupId> </plugins> </pluginManagement> </build> 可以修改此处 html 和 pdf,通过 mvn asciidoctor /docs/asciidoc/html</outputDirectory> <backend>html</backend> 执行 mvn asciidoctor
后来读者朋友先后给我推荐了gitbook [7] 和asciidoctor [8]。gitbook的能力自不必说,不少出版社都在使用,而且其生成的html可以用做交互式教学,很适合技术类的电子书。 想了解asciidoc的语法,可以google asciidoctor syntax。 所以我只好自己写一个,使用了这些工具: ✓ asciidoctor,一个基于ruby的asciidoc → html的命令行工具。 Makefile如下: ADOCTOR=asciidoctor PRINCE=prince CSSLINER=bin/cssliner CAT=cat BOOK=book.adoc SUFFIX=suffix.adoc
<plugin> <groupId>org.asciidoctor</groupId> <artifactId>asciidoctor-maven-plugin</artifactId> <toc>left</toc> </attributes> </configuration> </plugin> 通过上面的配置,执行该插件的asciidoctor
<plugin> <groupId>org.asciidoctor</groupId> <artifactId>asciidoctor-maven-plugin 配置执行命令 通过上面的配置,执行该插件的asciidoctor:process-asciidoc命令之后,就能在docs/asciidoc/html目录下生成最终可用的静态部署HTML了。
properties> <snippetsDirectory>${project.build.directory}/generated-snippets</snippetsDirectory> <asciidoctor.input.directory >${project.basedir}/docs/asciidoc</asciidoctor.input.directory> <generated.asciidoc.directory>${project.build.directory }/asciidoc</generated.asciidoc.directory> <asciidoctor.html.output.directory>${project.build.directory }/asciidoc/html</asciidoctor.html.output.directory> <asciidoctor.pdf.output.directory>${project.build.directory }/asciidoc/pdf</asciidoctor.pdf.output.directory> </properties> <dependencies> <!
groovy.test.GroovyAssert.shouldFail // Create List that is unmodifiable. def list = ['Groovy', 'Gradle', 'Asciidoctor
---- 你首先需要添加到 org.springframework.boot 到插件中: 例如下面的代码: plugins { id 'maven-publish' id "org.asciidoctor.convert