在前端开发中,我们通常都会遇到需要在 Confluence 系统中发布或编辑文档的情况。为了方便操作,我们可以使用 npm 包 confluence-tool。
安装
使用以下命令进行安装:
npm install -g confluence-tool
配置
首先需要在 Confluence 系统中生成 API token。登录到 Confluence 系统后,依次打开【个人设置】→【API token】,生成一个新的 token。
然后在命令行中使用以下命令进行配置:
confluence-tool configure
根据提示输入 Confluence 系统的 URL、用户名和 API token 即可完成配置。
使用
创建文章
使用以下命令创建一个新的文章:
confluence-tool create-page '文章标题' '空间名称' '父页面标题' '文章内容'
其中,空间名称和父页面标题是可选参数。如果没有指定空间名称,则会使用默认的空间。如果没有指定父页面标题,则会创建一个新的父页面。
更新文章
使用以下命令更新一个已有的文章:
confluence-tool update-page '文章标题' '文章内容'
删除文章
使用以下命令删除一个已有的文章:
confluence-tool delete-page '文章标题'
查询文章
使用以下命令查询一个已有的文章:
confluence-tool get-page '文章标题'
查询空间
使用以下命令查询所有的空间:
confluence-tool get-spaces
示例代码
-- -------------------- ---- ------- ----- ---------- - -------------------------- ----- ---- - - --------- ---------------- --------- ---------------- -------- ---------------------------------- ------ ------------ -- ----- ---------- - --- ----------------- -- ---- ----------------------- ------ ------- ------ ------- --------- ---- ---- ----- - -------- - ------ ------- --------------- --------- - - ------------ -- - -------------------- ------- --------- ------------ -- - ------------------- --- -- ---- ------------------------------------------- -- - ----------------------- - --------- ------ ---------------------------- ------------ -- - -------------------- ------- --------- ------------ -- - ------------------- --- -- ---- ------------------------------------------- -- - ------ ------------------------------- ---------- -- - -------------------- ------- ------------ -- - ------------------- --- -- ---- ------------------------------------------- -- - ------------------ ------------ -- - ------------------- --- -- ---- ---------------------------------- -- - ---------------------- -------- ------------ -- - ------------------- ---
总结
npm 包 confluence-tool 提供了一系列方便的命令行工具,可以帮助我们更方便地在 Confluence 系统中发布和编辑文档,提高开发效率。在使用时需要注意配置 API token 和命令参数的使用。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/6005604381e8991b448de708