记docsify的使用,动态生成文档网站工具

仿佛发现了新大陆,推荐一款神奇的文档网站生成工具-Docsify,适合编写线上文档,可结合Github,最重要的是他支持Markdowm语法,编写起来很是方便

什么是docsify

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

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

点击 docsify 访问官方教程

快速开始

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

npm i docsify-cli -g

初始化项目

如果想在项目的 ./docs 目录里写文档,直接通过 init 初始化项目。

docsify init ./docs

开始写文档

初始化成功后,可以看到 ./docs 目录下创建的几个文件

    index.html 入口文件
    README.md 会做为主页内容渲染
    .nojekyll 用于阻止 GitHub Pages 会忽略掉下划线开头的文件

直接编辑 docs/README.md 就能更新网站内容,当然也可以写多个页面。

本地预览网站

运行一个本地服务器通过 docsify serve 可以方便的预览效果,而且提供 LiveReload 功能,可以让实时的预览。默认访问 http://localhost:3000

docsify serve docs
Last modification:November 24th, 2019 at 04:11 pm
If you think my article is useful to you, please feel free to appreciate

Leave a Comment