辅助标签
Ascidoctor.js 扩展名,将标签块添加到 AsciiiDoc 语法中.
安装
此软件包取决于 asciidoctor 软件包(qq 2. 2. 2. 0, < 3. 0.0),但并未宣布它是依赖关系.
因此,在安装这个包时必须安装这个包.
$ npm i asciidoctor @asciidoctor/tabs
语法
标签集使用附加在标签样式附加说明的示例块中的描述列表(dlist)来定义.
[tabs]
====
Tab A:: Contents of Tab A.
Tab B::
+
Contents of Tab B.
Tab C::
+
--
Contents of Tab C.
Contains more than one block.
--
====
您可以选择将块分隔器的长度从典型的 4 个字符扩展至 6 个,以避免与标签块内的任何示例块相冲突(或只是风格问题).
[tabs]
======
Tab A::
+
====
Example block in Tab A.
====
Tab B:: Just text.
======
使用这种技术,也可以创建嵌入式制表器.
[tabs]
======
Tab A::
+
Selecting Tab A reveals a tabset with Tab Y and Tab Z.
+
[tabs]
====
Tab Y:: Contents of Tab Y, nested inside Tab A.
Tab Z:: Contents of Tab Z, nested inside Tab A.
====
Tab B:: Just text.
======
使用量
国 际
$ npx asciidoctor -r @asciidoctor/tabs tabs.adoc
这个 asciidoctor 命令在需要软件包时自动登记标签扩展.
API 密码
与 Asciidodor.js API 有两种方式使用扩展.
无论哪种情况,你都必须需要Asciidodor.js模块(asciidoctor在需要这个之前.
您可以调用导出 register 没有参数将扩展注册为全局扩展.
const Asciidoctor = require('asciidoctor')()
require('@asciidoctor/tabs').register()
Asciidoctor.convertFile('tabs.adoc', { safe: 'safe' })
或者你可以通过注册实例 register 将扩展的登记方法纳入范围登记.
const Asciidoctor = require('asciidoctor')()
const registry = Asciidoctor.Extensions.create()
require('@asciidoctor/tabs').register(registry)
Asciidoctor.convertFile('tabs.adoc', { extension_registry: registry, safe: 'safe' })
您还可以要求 @asciidoctor/tabs/extensions 访问 Extensions 课.
附于该对象的有: Block, (中文(简体) ), Docinfo.Style,以及 Docinfo.Behavior 扩展课程.
您可以使用这些课程注册备注标签扩展名 .
版权和许可证
版权 (C) 2018年至今 丹·艾伦(OpenDevise Inc.)和该项目的个人贡献者. 该软件的使用根据麻省理工学院许可证的规定准予.