用docsify快速构建文档,并用GitHub Pages展示

什么是docsify

无需构建,写完 markdown 直接发布成文档,写说明文档的极佳选择。

快速上手

安装

npm i docsify-cli -g
docsify init docs

创建项目

新建一个空项目,接着创建一个 docs 目录并进入到 docs 目录下

mkdir my-project && cd my-project
mkdir docs && cd docs

创建入口文件

根目录下创建index.html 文件

<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="UTF-8">
  <title>li.css</title>
  <meta name="description" content="Description">
  <meta name="viewport" content="width=device-width, user-scalable=no, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0">
  <link rel="stylesheet" href="//unpkg.com/docsify/themes/vue.css">
</head>
<body>
  <div id="app"></div>
</body>
<script src="//unpkg.com/docsify/lib/docsify.js" data-router data-repo="https://helijun.github.io/pages/docs/index.html"></script>
</html>

预览

docsify serve docs

docsify自动监听3000端口,浏览器输入 http://localhost:3000
就可以看到你在README.md里面编辑的内容了

发布到 GitHub Page

将文档托管到github,这样就可以随时随地访问了。
新建一个仓库,在setting里面开启 GitHub Pages 功能,如图:

浏览器输入https://helijun.github.io/pages/. 就可以看到你的文档了,当然如果你这个仓库包含了其他的文档的话 select source那里选择master branch,这样就不会影响其他文档的浏览,比如我的最终链接是 https://helijun.github.io/pages/docs/index.html#/,暂时存放LIUI的草稿文档

其他参考

官方文档:https://docsify.js.org/zh-cn

posted @   微人类  阅读(4124)  评论(0编辑  收藏  举报
编辑推荐:
· 如何编写易于单元测试的代码
· 10年+ .NET Coder 心语,封装的思维:从隐藏、稳定开始理解其本质意义
· .NET Core 中如何实现缓存的预热?
· 从 HTTP 原因短语缺失研究 HTTP/2 和 HTTP/3 的设计差异
· AI与.NET技术实操系列:向量存储与相似性搜索在 .NET 中的实现
阅读排行:
· 周边上新:园子的第一款马克杯温暖上架
· Open-Sora 2.0 重磅开源!
· 分享 3 个 .NET 开源的文件压缩处理库,助力快速实现文件压缩解压功能!
· Ollama——大语言模型本地部署的极速利器
· DeepSeek如何颠覆传统软件测试?测试工程师会被淘汰吗?
点击右上角即可分享
微信分享提示