1. 安装node
下载安装即可: https://nodejs.org/zh-cn/
下载文件:
https://nodejs.org/dist/v12.16.1/node-v12.16.1-x64.msi
https://nodejs.org/dist/v13.11.0/node-v13.11.0-x64.msi
2. 安装git
下载文件:
https://github.com/git-for-windows/git/releases/download/v2.25.1.windows.1/Git-2.25.1-32-bit.exe
https://github.com/git-for-windows/git/releases/download/v2.25.1.windows.1/Git-2.25.1-64-bit.exe
3.npm安装docsify
docsify中文官方地址:https://docsify.js.org/
1). 安装 docsify-cli
工具
推荐安装 docsify-cli
工具,可以方便创建及本地预览文档网站。
$npm i docsify-cli -g
2). 初始化新项目
如果想在项目的 ./docs
目录里写文档,直接通过 init
初始化项目。
$docsify init ./docs
3). 项目结构说明
初始化成功后,可以看到 ./docs
目录下创建的几个文件
index.html
入口文件
README.md
会做为主页内容渲染
.nojekyll
用于阻止 GitHub Pages 会忽略掉下划线开头的文件
直接编辑 docs/README.md
就能更新网站内容,当然也可以多个页面。
4). docsify命令启动项目
运行一个本地服务器通过 docsify serve
可以方便的预览效果,而且提供 LiveReload 功能,可以让实时的预览。默认访问 http://localhost:3000 。
$docsify serve docs
更多命令行工具用法,参考 docsify-cli 文档。
更多用法请参考官网:https://docsify.js.org/
笔者的微信公众号,每天一篇好文章:
最新评论