快速文本处理和发布工具链 Asciidoctor

MIT
Ruby
Windows
2014-11-14
Terry_Zheng

Asciidoctor 是一个针对 AsciiDoc 标记语言的快速文本处理和发布工具链,可以把内容转换成 HTML5、DocBook 5(或4.5)或者其他格式。 Asciidoctor 是用 Ruby 写的,并打包成一个 RubyGem 并发布到 RubyGems.org。多个Linux发行版都包含这个 Gem,包括 Fedora 、Debian 、Ubuntu。 Asciidoctor 是开源的,托管在 GitHub 上,并在MIT许可下发布。

    Use AsciiDoc for document markup. Really. It's actually readable by humans, easier to parse and way more flexible than XML. — Linus Torvalds

AsciiDoc 简介》介绍了博主看好 AsciiDoc 的原因,《Pro Git》这本书也是用 AsciiDoc 写的,请看《Living the Future of Technical Writing》,中文版请移步《实践的、技术写作的未来》。

Asciidoctor 的标记语言和 Python 版的 AsciiDoc 有一点小区别,建议先看《AsciiDoc Syntax Quick Reference》和《Asciidoctor User Manual》,User Manual 有从 MarkDown 和 Asciidoc 迁移到 Asciidoctor 的内容。


下面是我使用 Atom 编辑 AsciiDoc 的截图,和生成的 HTML 文件在 Chrome 中的截图:

adoc00 Atom IDE 和 Asciidoc Preview 插件

adoc01 HTML 页面预览-1

adoc02 HTML 页面预览-2

加载中

评论(3)

庄生dream
庄生dream
感觉扩展型要比MarkDown要好些,http://chloerei.com/2014/10/16/asciidoc-introduction/ 这是AsciiDoc的简介。 随便在学学Ruby
loyal
loyal
这个...哪里比MarkDown好? #Asciidoctor#
liango
liango
Ruby 程序员最要好的朋友 #Asciidoctor#

暂无资讯

4
回答
求一款文档展示的平台

很多时候做一个开放平台或者软件,需要吧用途,场景,API手册,用户手册等放到网站上。类似下面: https://www.qcloud.com/docume...

2017/03/15 19:34
1
回答
AsciiDoctor工具的使用

@Terry_Zheng 你好,想跟你请教个问题: 我在oschina上看到你的文章快速文本处理和发布工具链 Asciidoctor,然后这两天一直在学习...

2015/08/25 16:58

没有更多内容

加载失败,请刷新页面

没有更多内容

Asciidoctor Maven 插件

参考资料 1,使用Swagger2Markup、asciidoctor-maven-plugin和asciidoctorj-pdf插件生成PDF格式的API文档中文问题解决 2、asciidoc最佳实践-maven插件 3、Asciidoctor Maven插件使用 4、Asc...

05/07 14:28
26
0
swagger-ui + swagger2markup-cli + asciidoctor 生成api文档

参考:https://segmentfault.com/a/1190000017873594?utm_source=tag-newest swagger-ui地址为:http://sample.com:8888/zk/swagger-ui.html 通过https://github.com/Swagger2Markup/swagger...

05/20 20:46
20
0
spring-restdocs的研究

该框架通过单元测试来生成REST接口的说明文档,详见Spring REST Docs 可以对参数和返回值进行说明,还能产生url和返回用例 通过完善单元测试,和目前的mockMvc框架相结合,可以产生Asciidoct...

2016/07/22 10:57
61
0
Build RESTful APIs with Spring MVC: Swagger

#Visualizes REST APIs with Swagger Swagger is widely used for visualizing APIs, and with Swagger UI it provides online sandbox for frontend developers. ## Visualizes REST APIs [...

2016/07/25 15:17
151
0
Spring Rest Docs WebTestClient自动生成接口文档Gradle版

文章同步在个人博客 以前接口文档都是用swagger2在线文档,最近升级为spring boot2 + webflux反应式编程后,swagger2不支持webflux,无法使用,因此文档生成改为官方的spring rest docs,实践...

2018/09/10 14:29
338
1
maven指定execution id的方式来执行目标

有时候碰到同一种目标又多种配置方式,需要手动指定execution id方式来执行 IDEA执行maven任务默认使用IntelliJ IDEA 2016.1.3/plugins/maven/lib/maven3,不支持asciidoctor:process-ascii...

2016/07/22 10:57
36
0
SpringBoot非官方教程 | 第十篇: 用spring Restdocs创建API文档

转载请标明出处: http://blog.csdn.net/forezp/article/details/71023510 本文出自方志朋的博客 这篇文章将带你了解如何用spring官方推荐的restdoc去生成api文档。本文创建一个简单的sprin...

06/01 18:51
0
0
Java B2B2C多用户商城 springcloud架构 (十)用spring Restdocs创建API文档

这篇文章将带你了解如何用spring官方推荐的restdoc去生成api文档。本文创建一个简单的springboot工程,将http接口通过Api文档暴露出来。只需要通过 JUnit单元测试和Spring的MockMVC就可以生成...

03/18 08:59
9
3
SpringBoot非官方教程 | 第十篇: 用Spring Restdocs创建API文档

https://blog.csdn.net/forezp/article/details/70341818 本文出自方志朋的博客 准备工作 你需要15min Jdk 1.8 maven 3.0+ idea 创建工程 引入依赖,其pom文件: <dependencies> <dependency...

04/21 21:41
0
0
Java springcloud B2B2C o2o多用户商城 springcloud架构(十)用spring Restdocs创建API文档

这篇文章将带你了解如何用spring官方推荐的restdoc去生成api文档。本文创建一个简单的springboot工程,将http接口通过Api文档暴露出来。只需要通过 JUnit单元测试和Spring的MockMVC就可以生成...

01/15 08:59
4
2

没有更多内容

加载失败,请刷新页面

返回顶部
顶部