生活
asciidoc 、asciidoctor graphviz
2023-04-07 02:38  浏览:40

有没有工具将word转成asciidoc

word文档直接转换为图片形式的软件是没有的,可以采用截图手段转换为图片,或者转换为pdf格式查看。转换为pdf格式文件方法如下:1、打开电脑下载wps软件并安装,2、用wps打开word文档,点击文件-另存为-输出为pdf格式,选择保存位置及文件名,点击确定后,即可查看转换的pdf文件。

Markdown 替代品 Asciidoc 介绍

AsciiDoc,它的设计初衷就是为了解决写书规模的问题,并且是 O’Reilly 的在线出版平台 Atlas 的推荐语言。经过一番学习,我觉得 Asciidoc 确实很适合电子书制作。

AsciiDoc 相比 Markdown 支持更多的格式,包括而不限于:

Markdown 通过自行扩展语法或者使用 HTML 可以实现这些格式,但前者造成文档不通用的问题,后者则直接把展示结构硬编码到了文档中,将来修改会很麻烦。

当然, 更多的特性带来更多的学习成本,对于博客等简单文档,这些特性并不是必须的,但对于电子书等大型文档,标准内提供丰富的特性就很有必要,否则就需要自己实现不成熟、不兼容的扩展。

AsciiDoctor 是 AsciiDoc 的 Ruby 实现,也是一个工具链,实现了 AsciiDoc 对 HTML5/DocBook/EPUB/PDF/MOBI 的转换(有的需要借助第三方工具例如 Kindlegen)。相比原版 Python 实现,AsciiDoctor 作了以下改进:

AsciiDoctor 是一个很宏伟的项目,还有很多子项目在开发中,例如我比较关注的 Asciidoctor PDF 和 Asciidoctor EPUB3,这两个项目用于去掉现有工具链中对 DocBook 的依赖,由原文档直译目标文档。工具链层次的减少可以增加定制便利性,也更方便用户安装。

示例一:

示例二:

[推荐] Visual Studio Code 和配套asciidoctor-vscode插件

asciidoctor 官网

asciidoc 官网

AsciiDoc 简介

asciidoctor-vscode插件的 Github 地址

asciidoc文件怎么查看

在我发展一个Python模块为开发者提供KP-ABE和CP-ABE功能。一个重要方面是文档。任何像样的项目需要提供用户和开发人员文档。用户文档是对外,告诉用户如何使用该项目,和开发人员文档是对内,告��开发人员项目是如何构成的。开发人员文档和参考文档也知道。有趣的是,用户文档可以进一步分为两组:用户 u2014for当用户只是一个 u2018plain-dumb-user ';Dev-User u2014when项目产生一些供其他开发者使用即一个图书馆。经常Dev-User文档只是参考文档。这篇文章是关于参考文档。

记录API u2019s和库不同的语言有不同的工具:

Java Javadoc,Doxygen

Python epydoc,pydoctor pydoc,狮身人面像,Doxygen

C u2026 gtk-doc u2026,Doxygen

设计总有plantuml。

用户文档,通常没有绑定到一个特定的编程语言有不同的格式:

乳胶

斯芬克斯

ASCIIDOC

减价

休息

DocBook

对于开发人员面临的文档,可以使用上述工具的组合。特别是,当产生UML图。

开发代码时,我尝试使用doxygen无论我走到哪里,doxygen是跨越语言和提供了一个好的意味着生产:终端用户,Developer用户,开发者在HTML文档、手册页,乳胶,RTF和XML;跨多个语言。这是给你下降到c .此外,doxygen支持乳胶配方在文档中了。此外,最新版本的doxygen允许减价的使用,和包容的减价格式化文件。它本质上是SwissArmy刀的文档。

然而,当发展中在Python中首选的文档工具是斯芬克斯,剩下依靠马克在Python u2018docstrings u2019产生参考文档和其他文件,用户文档。我发现这种方法混乱,尤其是休息。

Helaas,Doxygen u2019t想打好,并喜欢它的文档在特殊的注释块方法定义即之上。

##

#打印消息发送到STDOUT

# @param味精要打印的消息

#

def print_message(味精):

打印(味精);

而不是在文档字符串。幸运的是doxypy过滤器,允许有一个告诉doxygen看看文档字符串。因此,上面的代码片段可以成为:

def print_message(味精):

”““打印消息发送到STDOUT

@param味精要打印的消息。

"""

打印(味精);

python和doxygen一起很好地工作,除了标准的设置,以下配置设置还建议/要求:

INPUT_FILTER =“python /道路/ / doxypy.py”

FILTER_SOURCE_FILES = YES

HIDE_UNDOC_RELATIONS =没有

OPTIMIZE_OUTPUT_JAVA = YES

JAVADOC_AUTOBRIEF = YES

MULTILINE_CPP_IS_BRIEF = YES

DETAILS_AT_TOP = YES

EXTRACT_ALL = YES

EXTRACT_STATIC = YES

SHOW_DIRECTORIES = YES

SOURCE_BROWSER = YES

ALPHABETICAL_INDEX = YES

COLS_IN_ALPHA_INDEX = 8

TOC_EXPAND = YES

DISABLE_INDEX = YES

GENERATE_TREEVIEW = YES

值得注意的是,使用最新版本的Doxygen可以引用一个减价文件的主页。

例如python项目使用Doxygen,看到pyPEBEL。

引用:

自动文档使用Doxygen Python代码

从Python源文件创建文档Doxygen和doxypy

使用doxypy Python代码文档

使用Doxygen中的Readme MD文件作为主页

Swagger离线文档生成

离线接口文档自动生成器

适用范围:

将标准的swagger.json文件解析并转换成一定格式的接口文档,其中文档的章节排序可以在index.adoc中自定义排序。生成的接口文档有html和pdf格式两种,由于插件转换中文需要特殊配置,默认生成的含中文的文档存在一定字体错乱,所以建议使用html格式文档。Html格式文档可以使用word打开,并转换成其他格式。

操作步骤:

1.      [endif]将ConvertSwagger.rar解压出来

2.      [endif][可选步骤]修改ConvertSwaggersrcdocsasciidoc文件夹下面的index.adoc与manual_content.adoc,manual_content.adoc。index.adoc中可以将manual_content.adoc添加进去:

并在manual_content.adoc中添加自定义描述内容:

(可选)

3.      [endif]在ConvertSwaggertargetswagger中添加swagger.json文件

4.      [endif]编译此工程 在ConvertSwagger目录中 mvn package

5.      [endif]在ConvertSwaggertargetasciidochtml中拿到html格式的接口文档,自动生成的文档名称默认是index.html。

关于asciidoc和asciidoctor graphviz的介绍到此就结束了,不知道你从中找到你需要的信息了吗 ?如果你还想了解更多这方面的信息,记得收藏关注本站。

发表评论
0评