npm 包 docsify-cli 使用教程

阅读时长 3 分钟读完

前言

随着前端技术的发展,我们经常会使用各种工具来提高项目开发效率。其中,docsify-cli 是一款通过 Markdown 文件生成文档网站的工具,能够帮助我们更加高效地创建和维护文档。本文将详细介绍如何使用 docsify-cli。

安装

安装 docsify-cli 非常简单,只需在命令行中运行以下命令即可:

这里我们使用 npm 进行安装,并且添加了 -g 参数,表示全局安装,方便我们在任意目录下使用。

使用

初始化项目

在使用 docsify-cli 之前需要先初始化一个项目,在项目根目录下执行以下命令:

这里我们将项目文档存放在 ./docs 目录下,当然你可以自定义目录。执行完上述命令后,会在 ./docs 目录下生成以下文件:

其中,index.html 是文档网站的入口文件,.nojekyll 是为了 Github Pages 禁用 Jekyll 的文件,README.md 是我们的首页内容。

预览项目

初始化完成后,我们就可以预览项目了。在命令行中进入项目根目录,执行以下命令:

然后在浏览器中打开 http://localhost:3000,就可以看到我们的文档网站了。

编写文档

在项目根目录下的 ./docs 目录中,我们可以创建各种 Markdown 文件来编写文档。docsify-cli 支持很多 Markdown 扩展语法,如代码块、表格等。

自定义配置

如果我们需要对文档网站进行一些自定义配置,可以在项目根目录下的 ./docs 目录中创建一个名为 _config.yml 的文件,并在其中添加如下内容:

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

这个配置文件中,namedescription 分别指定文档网站的名称和描述。theme 部分用于指定主题和侧边栏的设置,这里我们使用了 vue 主题,并且定义了 guide 目录下的三个文档作为侧边栏菜单。

部署网站

最后,当我们完成了文档的编写和自定义配置之后,需要将文档网站部署到服务器上才能让其他人看到。docsify-cli 提供了多种部署方式,可以参考官方文档进行部署。

总结

本文介绍了如何安装和使用 docsify-cli 工具来创建和维护文档网站。希望对初学者有所帮助。

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

纠错
反馈