npm 包 @jurajkubelka/wiki 使用教程

阅读时长 4 分钟读完

在前端开发中,我们经常需要查阅文档来学习,解决问题和做决策。而 @jurajkubelka/wiki 是一个可以帮助我们方便地访问和显示文档的 npm 包。本文将带领大家学习如何使用 @jurajkubelka/wiki 命令行工具来查看和展示文档。

安装

使用 npm 来安装 @jurajkubelka/wiki:

使用 -g 参数可以将它安装到全局,这样我们就可以在命令行中直接使用 wiki 命令。

使用

命令 wiki -s

使用 wiki -s 来搜索文档。例如,我们想要查找所有和 JavaScript 相关的文档,可以使用以下命令:

这将返回所有和 JavaScript 相关的文档列表以及它们的描述。

命令 wiki -l

使用 wiki -l 显示所有支持的语言。命令 wiki -l 返回以下列表:

  • en: 英语
  • cs: 捷克语
  • de: 德语
  • es: 西班牙语
  • fr: 法语
  • hu: 匈牙利语
  • it: 意大利语
  • ja: 日语
  • ko: 韩语
  • nl: 荷兰语
  • pl: 波兰语
  • pt: 葡萄牙语
  • ru: 俄语
  • sk: 斯洛伐克语
  • uk: 乌克兰语

使用 wiki -l [ISO 639-2 语言代码] 来显示你想要的特定语言的文档。例如,使用以下命令来查看法语文档:

命令 wiki [语言代码] [页面名]

使用命令 wiki [语言代码] [页面名] 来显示特定语言和特定页面的文档。例如,我们想要查看 JavaScript 语言的 Promise 文档,可以使用以下命令:

命令 wiki -r

使用命令 wiki -r 来显示最近访问的页面。命令会列出最近查看过的文档,最近查看的文档将被置前。

使用示例代码

我们可以将 wiki 命令结合其他命令和模块来完成更复杂的任务。下面是一个使用 wiki 命令来获取 JavaScript Promise 的简单示例:

-- -------------------- ---- -------
----- ----- - -----------------
----- ------- - -------------------
----- - -------- - - -------------------------

----- ---------- - ---- -- ---------------------------------------------

----- ------------ - ----- --
  ------------------------------------------------------------------------------------------------------------------------------------------

----- ------ - ----- ----- -- -
  ----- - ---- - - ----- -------------------------------
  ----- -- ---------- ---- -- - --------------
  ------ -------------- -- -----
--

----- ---------- - ----- ---- -- -
  ----- ---- - -------------- -- ---------------------
  ----- - - -------------------
  ------ ------------------- ----------- -- -------------- -- ---- -------
--

------ -- -- -
  ----- ---- - ----- ------------------
  ----- ------- - ----- -----------------
  ---------------------
---------------- -- ----------------------

在这个例子中,我们首先将页面名 promise 传递给 search 函数来获取页面的 Slug。然后,我们使用 getSummary 函数来获取摘要并输出它。

结论

现在我们已经知道如何使用 @jurajkubelka/wiki 包查找和显示文档。这个工具简单而强大,帮助更快地学习和开发。当你在工作中遇到文档问题时,可以不再烦恼了。

来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/151429