【文档插件】使用intellij IDEA AsciiDoc插件查看SpringCloud alibaba 开发文档

背景

我们开发过程中,查看SpringCloud alibaba开源代码文档中出现了.adoc文件,为了了解并使用这个文件,简单记录以下功能和用法,方便后续查阅使用.

adoc 文档编辑利器

asciiddoc功能比较强大,比markdown给为强大,但是也复杂一下,使用门槛稍高,但不过还好。查查手册经常谢谢,很容易掌握的。

markdown 大家基本都熟悉,作为程序员,进行知识管理,用markdown 有点很多。例如我就喜欢他语法简洁,在积累下来的大量文档中搜索变的比较容易。比word要强多了。

markdown和asciidoc的比较

https://asciidoctor.org/docs/asciidoc-vs-markdown/

上边链接有个表格,详细的比较了两个的差别。不得不说asciidoc确实有其优点,缺点是语法更加复杂一些了,学习成功更为加的高了一点。

怎么开始写adoc

和写markdown的方法一样,只要用一个文本文件就可以,写好保存为扩展名为adoc的文件即可。浏览方式在chrome浏览器上安装个插件,就可以实时浏览adoc文档的效果了。

在哪查adoc的语法?

https://asciidoctor.org/docs/#the-basics

如上链接中可以找到详细的手册,写的非常的详细,用哪查哪就行了。除了手册还有其他的一些知识,例如 一些工具等等的。 基本的写法和markdown的思路非常类似。

asciidoc的预览

如何安装google浏览器的asciidoc插件?

  • 到网址 https://asciidoctor.org/docs/editing-asciidoc-with-live-preview/ 下载浏览器插件。
  • 把插件asciidoctor-chrome-extension.nex 下载下来。
  • 把扩展名改为rar,再解压到目录中。
  • 用chrome打开 chrome://extensions
  • 点击加载已解压的扩展包 按钮,选择上边解压出来的文件目录即可。

使用AsciiDoc 插件 for IntelliJ platform 可以预览

在IDEA中安装AsciiDoc 后,打开adoc 文件,右则即可以同步预览;如下图所示:
在这里插入图片描述

使用vscode可以预览

使用比较简单,只要安装vscode,再在vscode里安一个能预览asciidoc的插件,打开asciidoc文档,再点preview就可以了。

使用AsciidocFX

这款软件是专用于编辑asciidoc文档,可以它来写文档,也可以用它把文档转换为其它的格式,例如pdf,html等等。

adoc 每个文档头初始的例子

:sectnums:    //显示每章的章节
//:toc: macro
:toc: left
:source-highlighter: pygments
:pygments-linenums-mode: inline
:sectnumlevels: 5
:toclevels: 5
發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章