预览
使用工具
一个神奇的文档网站生成器 docsify
安装doocsify
-
npm i docsify-cli -g
初始化项目
-
# docs:项目目录 docsify init ./docs
项目结构
index.html
入口文件README.md
会做为主页内容渲染.nojekyll
用于阻止 GitHub Pages 忽略掉下划线开头的文件- 更多自定义内容,查阅官网:docsify
本地预览
-
# docs:项目目录 docsify serve docs
插件安装
按照官网步骤安装:引入对应js,配置docsify对象
插件介绍,效果预览
全文搜索 - Search
-
文档左上角搜索框
-
// todo 搜索某些关键词,search.min.js报错 search.min.js:1 Uncaught TypeError: Cannot read properties of undefined (reading 'substring')
-
谷歌统计 - Google Analytics
- 需要Google账号,可使用百度统计,参考博客:百度统计使用教程
- 统计网站的访问情况
emoji
- 解析 emoji
外链脚本 - External Script
- 执行外链脚本
图片缩放 - Zoom image
- 可放大图片
在 Github 上编辑
- 文档右上角 Edit on github 图标,可配置链接到github地址
复制到剪贴板
- 鼠标移入代码区,显示 Copy to clipboard 按钮
Gitalk
-
基于Preact和Github Issue的评论系统
-
解决报错:Gitalk Error: Validation Failed. 442,原因是:文章URL过长,解决方法参考博客:处理 Gitalk Validation Failed(422)
-
Pagination
-
docsify的分页导航插件
-
字数统计
- 文章字数统计,文档右上角显示
Tabs
- 在 Markdown 中显示选项卡
docsify-sidebar-collapse
- 侧边栏折叠插件,安装参考博客:docsify 侧边栏目录扩展
部署到Github
Create a new repository
将本地的docs项目push到新建的仓库
- 参考博客:docsify搭建高逼格博客
GitHub Pages 绑定二级域名
- 参考博客:GitHub Pages 绑定二级域名
参考博客
- 处理 Gitalk Validation Failed(422)
- docsify搭建高逼格博客
- GitHub Pages 绑定二级域名
- docsify 侧边栏目录扩展
- 百度统计使用教程一
- Docsify快速搭建个人博客
公众号: