【docsify】为网站写一个说明文档

【docsify】为网站写一个说明文档

!官方部署文档

全局安装

npm i docsify-cli -g

全局安装

初始化项目

在项目文件夹下,初始化

docsify init ./docs

在这里插入图片描述
会生成三个文件
在这里插入图片描述

./docs 下

  • index.html作为入口文件
  • README.md作为主页
  • .nojekyll防止 GitHub Pages 忽略以下划线开头的文件

可以轻松地更新文档中的内容./docs/README.md
也可以添加更多页面

入口(封面)

打开index.html
在这里插入图片描述

	name: '', //名称repo: ''   //git地址

添加一行,开启渲染封面的功能

 	coverpage: true

完成编写后保存

本地预览

docsify serve ./docs

在这里插入图片描述
在 http://localhost:3000/#/ 下预览
在这里插入图片描述

封面

新建文档_coverpage.md
为封面写入简略说明,保存
在这里插入图片描述
还可修改

![](_media/bg.png)![color](#f0f0f0)

且主题(index中的css样式)也有多种选择

  

URL生成二维码

生成二维码


本文来自互联网用户投稿,文章观点仅代表作者本人,不代表本站立场,不承担相关法律责任。如若转载,请注明出处。 如若内容造成侵权/违法违规/事实不符,请点击【内容举报】进行投诉反馈!

相关文章

立即
投稿

微信公众账号

微信扫一扫加关注

返回
顶部