Asciidoctor.js-2是一种在Web应用程序中使用Asciidoctor的最佳方式。Asciidoctor是一个用于撰写文档、幻灯片和在线帮助内容的强大工具。使用Asciidoctor.js-2，您可以将Asciidoctor文档从服务器端和客户端以各种格式传输，如HTML、PDF和ePub等。
安装
使用npm安装asciidoctor.js-2：
--- ------- ----------------
引用
使用ES6导入：
------ - -- ----------- ---- ------------------
如果您使用了旧版的Node.js，请改用CommonJS导入：
----- ----------- - -----------------------------
请注意：您需要在调用asciidoctor（）之后立即调用返回的对象，否则将出现错误。
使用
渲染文档
要将Asciidoctor文件渲染为HTML格式，请使用以下代码：
--- ---- - ------------------------------------------------ ------ -----------
此代码将在指定的路径处读取Asciidoctor文件，然后将其渲染为HTML。请注意，如果未指定安全级别，则默认情况下值为“safe”。如果您希望禁用所有的安全性检查，请将安全级别设置为“unsafe”。
渲染片段
如果您不想将整个文件渲染为HTML，而只是想将一个段落渲染为HTML，则可以使用以下代码：
--- ---- - --------------------------- ---------- ------------ ------------- --------
此代码将渲染“Hello，_world_！”这个段落，并将结果作为HTML字符串返回。使用“attributes”选项可以指定Asciidoctor文件中的属性。
设置选项
除了上述示例中使用的选项外，Asciidoctor.js-2还支持其他选项。例如，您可以设置以下选项：
------------------------------- --------- --------------------------------- -------- --- ---- - ------------------------------------------------ ------ --------- ----------- ------------- --------
此代码将设置“目录”选项和“图标”选项，并将Asciidoctor文件渲染为HTML。
使用扩展
Asciidoctor支持许多扩展，如Include、Image、Attribute等。要使用这些扩展，请在Asciidoctor.js-2中使用以下代码：
----- ---------------- - ----- ------- ------- ------ -- - ----- ------ - ---------------------------- ------------ -------- ----- ----- - --------------------------------- ------ ------------------------- ------- ------- -- ------- - ------------------------------------------ ------------------ --- ---- - ------------------------------------------------ ------ --------- ----------- ------------- --------
此代码将在Asciidoctor.js-2中注册一个名为“include”的扩展。该扩展允许您从其他Asciidoctor文件或URL中包含其他内容。要使用该扩展，请在Asciidoctor文件中使用“include”指令。
示例代码
以下示例演示了使用Asciidoctor.js-2渲染Asciidoctor文件，并将其呈现为HTML格式：
------ - -- ----------- ---- ------------------ ----- -------- - - - ----- ---- -- - ------------ - ----- ---- - ----------------------------- ------ ---------- -- ------- -- ---- ----------------- -- --- ------------------------ -- ---- ------------------ -- ------- -- - ------------------------------- -- ------ -- ------
总结
使用Asciidoctor.js-2，您可以轻松地将Asciidoctor文件渲染为多种格式，将其应用于您的Web应用程序中。此外，Asciidoctor.js-2还提供了许多选项和扩展，以帮助您更好地渲染和控制您的文档。
来源：JavaScript中文网 ，转载请联系管理员！ 本文地址：https://www.javascriptcn.com/post/60055b8381e8991b448d914f