docsify,一个神奇的文档网站生成器

无论您是开发者、写作爱好者还是企业用户,Docsify 都能帮助您轻松创建漂亮、易于浏览和管理的文档网站。它提供了一个现代化的界面和丰富的功能,使您能够以最小的努力构建高度可定制的文档网站。 docsify 可以快速帮你生成文档网站。不同于 GitBook 、 Hexo 的地方是它不会生成静态的 .html 文件,如果只是部署文档类的网站的话,部署这个会比部署 WordPress 等更为简单和省资源。

话不多说,我们来了解了解 docsify,官方网站如下 https://docsify.js.org/#/zh-cn/?id=docsify 可以在 linux,mac,Windows 上来使用,今天演示用 Windows 作为演示,步骤都是一样的

  1. 首先确保电脑上安装了 node 和 npm 如果没安装的话,安装一下即可,很简单
  2. 在安装好以上 2 个后。我们全局安装 docsify-cli 。输入命令 npm i docsify-cli -g 等待安装完毕即可
  3. 在电脑上新建一个目录,我们来这个目录里去写我们的文档,比如我这里的目录就是 docsify 。 通过 cmd 进入当前路径下,执行命令: docsify init ./ 之后,他会在当前目录下生成 3 个文件。分别是 index.html(页面的入口文件), readme.md(渲染内容)和 .nojekyll(用于组织 github pages 忽略掉下划线开头的文件),此时我们只需要更改 readme 里的内容就可以更新文档内容了 。
  4. 页面有了,我们想进行本地预览,输入 docsify serve ./ docsify 就会在本地启动一个服务器,Listening at http://localhost:3000 当页面输出这样的内容时候,我们浏览器访问: http://localhost:3000 就可以看到文档效果了。docsify,一个神奇的文档网站生成器 - 第1张图片
  5. 设置封面:我们只需要打开 index.html 里。里面新增配置即可 coverpage: true 此时再次进行文档预览就会发现有了一个渐变色的封面docsify,一个神奇的文档网站生成器 - 第2张图片
    <script>
     window.$docsify = {
       name: '',
       repo: '',
       coverpage: true
     }
  6. 当然了,封面上我们也想写一些内容或者自己自定义的图片,也很简单,我们在根目录,也就是 docsify 下新建一个文件,文件名是 _coverpage.md 里面用 markdown 的格式进行写你想输入的介绍 以及封面图片。例如我的效果如下:docsify,一个神奇的文档网站生成器 - 第3张图片

代码如下:

<!-- _coverpage.md -->


![logo](_media/windows.png)

# docsify <small>3.5</small>

> 一个神奇的文档网站生成器。

- 简单、轻便 (压缩后 ~21kB)
- 无需生成 html 文件
- 众多主题

[GitHub](https://github.com/docsifyjs/docsify/)
[Get Started](#docsify)

如果你想支持自定义背景,多个封面,以及定制导航栏什么的,docsify 都是支持的,具体可以参考官方文档:https://docsify.js.org/#/zh-cn/ 简单,轻量,非常好用 。你可以将你本地写好的文档部署到你的服务器或者 github pages 上,来让别人访问,总体来说,非常推荐,很好用

创作不易,如果您觉得这篇文章对你有帮助,不妨给我点个赞,这将是我继续分享优质内容的动力

《docsify,一个神奇的文档网站生成器》留言数:0

发表留言