docsify 教程

🌙
手机阅读
本文目录结构
axihe

相信很多人都有这种经历,一个项目写好了,尤其是一个组件库,你没有一个文档说明,谁能看得懂?所以一个好的项目,必须要有个通俗易懂的文档说明。当然,这些年 markdown 如火如荼,github 的 page 也可以让你快速生成一个简单的文档说明,但毕竟写来写去还是在一个 readme.md 上面做文章,如果一个项目或是组件够大,总不能所有的都写在一个文件里面吧!就算你写的再认真,说实话,也没人愿意去看。

docsify 是什么?

官方的介绍是:

A magical documentation site generator.

docsify 是一个动态生成文档网站的工具。不同于 GitBook、Hexo 的地方是它不会生成将 .md 转成 .html 文件,所有转换工作都是在运行时进行。

这将非常实用,如果只是需要快速的搭建一个小型的文档网站,或者不想因为生成的一堆 .html 文件“污染” commit 记录,只需要创建一个 index.html 就可以开始写文档而且直接部署在 GitHub Pages。

docsify 特性

  • 无需构建,写完文档直接发布
  • 容易使用并且轻量 (~19kB gzipped)
  • 智能的全文搜索
  • 提供多套主题
  • 丰富的 API
  • 支持 Emoji
  • 兼容 IE10+
  • 支持 SSR

安装 docsify-cli 命令行工具

docsify-cli 工具,可以方便创建及本地预览文档网站。

docsify 需要本地先安装 node, 如果没有安装 node,可在 node 官网选择对应操作系统下载安装:https://nodejs.org/zh-cn/

终端输入 npm i docsify-cli -g 进行全局安装:

npm i docsify-cli -g

/usr/local/bin/docsify -> /usr/local/lib/node_modules/docsify-cli/bin/docsify
> fsevents@1.2.4 install /usr/local/lib/node_modules/docsify-cli/node_modules/fsevents
> node install
[fsevents] Success: "/usr/local/lib/node_modules/docsify-cli/node_modules/fsevents/lib/binding/Release/node-v57-darwin-x64/fse.node" already installed
Pass --update-binary to reinstall or --build-from-source to recompile
> docsify@4.8.6 postinstall /usr/local/lib/node_modules/docsify-cli/node_modules/docsify
> opencollective postinstall

                         Thanks for installing docsify 🙏
                 Please consider donating to our open collective
                        to help us maintain this package.

          👉  Donate: https://opencollective.com/docsify/donate

+ docsify-cli@4.3.0
added 456 packages from 206 contributors in 32.827s

检查

安装结束后使用 docsify -v 查看是都安装:

docsify -v

docsify-cli version:
  4.3.0

AXIHE / 精选资源

浏览全部教程

面试题

学习网站

前端培训
自己甄别

前端书籍

关于朱安邦

我叫 朱安邦,阿西河的站长,在杭州。

以前是一名平面设计师,后来开始接接触前端开发,主要研究前端技术中的JS方向。

业余时间我喜欢分享和交流自己的技术,欢迎大家关注我的 Bilibili 和抖音。

关注我: Github / 知乎

如果你加我的私人微信,麻烦写上您的 称呼,所在地区,职业,方便我备注,谢谢


本站的微信公众号

阿西河前端教程

Anbang

安邦的私人微信

微信号: yaolushan

Anbang

Bilibili(B站)

朱安邦

Anbang