简介
@atlaskit/editor-wikimarkup-transformer 是一个用于将 Atlassian Confluence wiki 文本转换为 HTML 的 npm 包。可以在前端中使用该包来将 Confluence wiki 文本渲染为网页中的 HTML。该包是 Atlassian 公司开源的，可以通过 npm install 直接安装到项目中。
安装
在项目根目录下运行以下命令：
npm install @atlaskit/editor-wikimarkup-transformer
使用
在项目中引入 @atlaskit/editor-wikimarkup-transformer 并将 Confluence wiki 文本传入其中，即可将其渲染为 HTML。
-- -------------------- ---- ------- ------ --------------------- ---- ------------------------------------------ ----- -------- - ---- ---- -- - ------ ---- -- - ---------- - ----- ----------- - --- ------------------------ ----- ---------- - ----------------------------- ------------------------ -- ------- --------- -- - ------------------ -- - ---------------
参数
可以通过传递以下参数来自定义输出的 HTML：
1. locale (string)
指定输出 HTML 的语言。默认为 "en"。
const transformer = new WikiMarkupTransformer({ locale: 'zh' });2. mediaBaseUrl (string)
指定 Confluence wiki 中嵌入的媒体文件的根路径。默认为 undefined。
const transformer = new WikiMarkupTransformer({ mediaBaseUrl: 'https://myconfluence.atlassian.net/' });3. mentionNameResolver (function)
指定一个函数来解析 Confluence wiki 中的提及（mention）链接。默认为 undefined。
-- -------------------- ---- -------
----- -------- - --------- ------- -- -
----- ----- - -
------- - ----- ----- ------- ----- ------------ --
-- ---
--
------ -------------------------
-
----- ----------- - --- ----------------------- -------------------- -------- ---示例
以下是一段较长的 Confluence wiki 文本：
-- -------------------- ---- ------- ----------------------- ----- -- - ----- ---- ---- --------- - ---- -- - ------ ---- -- ----- ---- -- ------ ---- - ------- ------ ---- -- ----- ---- --- --- ---- - --- --- ---- - -- ------ ---- - ---- -- -- ------ ----------------------------------------------------------------------------------------- -------
将其传入 @atlaskit/editor-wikimarkup-transformer 并输出 HTML：
-- -------------------- ---- ------- ------ --------------------- ---- ------------------------------------------ ----- -------- - ------------------------ ----- -- - ----- ---- ---- --------- - ---- -- - ------ ---- -- ----- ---- -- ------ ---- - ------- ------ ---- -- ----- ---- --- --- ---- - --- --- ---- - -- ------ ---- - ---- -- -- ------ ----------------------------------------------------------------------------------------- --------- ----- ----------- - --- ------------------------ ----- ---------- - ----------------------------- ------------------------
输出结果：
-- -------------------- ---- ------- ---- ------------- ------------------------ ---------- --------------- -- - ----- ---- ---- --------------------- ---- -------- -- - ------ ---- ---- --------- --------- ---------- --------- ----- ----- ----------- ------ ---- ---- --------- ---- ---- ------- ---- ------ ------- ---- ------ ----- ----- ---------- --------- ----- ----- -------- -- -- ---------- ---- --------------------------------------------------------------------------------------------------- ----- ------
总结
@atlaskit/editor-wikimarkup-transformer 可以帮助前端开发者将 Confluence wiki 文本转换为 HTML，让网页显示更加完整和美观。通过参数的自定义，可以输出符合项目及用户需求的 HTML。该包的介绍、用法及示例的具体阐述，可以为前端开发者提供较为完善的回答和指导。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/5eedaa8cb5cbfe1ea0610504