asciidoctor

How to use tocify with asciidoctor for a dynamic toc?

孤者浪人 提交于 2020-06-24 04:53:17
问题 By default, asciidoctor creates a static toc. This is very cool but for long documents, it would be nice to if the toc could be somewhat more compact and would highlight where in the document the reader currently is. At this point, tocify comes in. Tocify is a nice Javascript solution exactly to cover this. Now the question is: how to use tocify with asciidoctor? Asciidoctor issue 699 is relevant here. 回答1: Enable docinfo processing in your asciidoc files, e.g. by passing the following

Asciidoctor Maven 插件

北战南征 提交于 2020-03-02 05:38:38
参考资料 1, 使用Swagger2Markup、asciidoctor-maven-plugin和asciidoctorj-pdf插件生成PDF格式的API文档中文问题解决 2、 asciidoc最佳实践-maven插件 3、 Asciidoctor Maven插件使用 4、 Asciidoctor Maven 插件 前言 AsciiDoc是一种轻量型的标记语言,语法简单易用,兼容Markdown的同时,提供了更丰富的标记功能,非常适用于写电子文档,Asciidoctor Maven 插件是一种官方支持的方式,它可以在 Apache Maven 构建过程中使用 Asciidoctor 转化你的 AsciiDoc 文档( .adoc) 文件格式转化为PDF、HTML、EPUB等文件格式。 POM.xm <properties> <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding> <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding> <maven.compiler.encoding>UTF-8</maven.compiler.encoding> <maven.compiler.source>1.8<

SpringBoot2中,怎么生成静态文档

流过昼夜 提交于 2020-01-07 20:28:40
【推荐】2019 Java 开发者跳槽指南.pdf(吐血整理) >>> SpringBoot2中,怎么生成静态文档 在实际开发过程中,我们通过swagger就可以生成我们的接口文档,这个文档就可以提供给前端人员开发使用的。但是,有时候,我们需要把我们的接口文档,提供给第三方合作公司怎么办? 本人现在就遇到这个问题。我们的项目开发完成之后,也是前后端分离的模式。但是,第三方公司需要我们的接口文档,怎么办?那就需要我们把swagger的文档,生成静态文档才可以发送过去。 接口文档 说起来接口文档,大家最熟悉的就是swaggger了吧。这个可以很方便的可以注解的方式,就可以生成我们需要的文档。而且可以在线调试接口。 随着前后端分离架构和微服务架构的流行,我们使用Spring Boot来构建RESTful API项目的场景越来越多。通常我们的一个RESTful API就有可能要服务于多个不同的开发人员或开发团队:IOS开发、Android开发、Web开发甚至其他的后端服务等。 上面就是项目启动之后,swagger给我们提供的可视化界面了。 swagger项目集成 springboot中集成swagger很简单,只需要我们导入依赖,然后在方法上写上注解就可以了。 应用主类中添加 @EnableSwagger2Doc 注解,具体如下 根据项目需要,我们可以修改swagger的默认配置