你知道框架文档是用什么写的吗?

docsify 介绍 

自从有了 Markdown, 我就再没用过富文本编辑器,因为 Markdown 的书写有一种心流的感觉。很多博客平台都支持 Markdown 了,即便是不支持,也没关系,可以通过 mdnice 或者 Md2All 转成富文本的格式。

docsify 可以自动地将 Markdown 中的标题生成目录,并且可以配合码云(国内的访问速度比 GitHub Pages 更快)快速搭建一个小型的文档网站,整个页面的配色和布局也十分舒适,让阅读体验在不知不觉中提升了好几个档次。

和 Gitbook 不同,docsify 不会生成静态的 HTML 文件,它会智能地加载和解析 Markdown 文件,这就避免了 HTML 文件对整个文档库的“污染”。

docsify 的官网:https://docsify.js.org/  

全局安装 docsify  安装后可以-v看下版本,看看是否安装成功

npm i docsify-cli -g

在文件夹目录下初始化

docsify init

完成后,您可以在子目录init中看到文件列表。./docs

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

直接打开html是看不了的,需要服务器上运行,所以我们启动本地服务器,你可以输入命令

docsify serve docs

也可以用vscode 插件 Live Server  来打开html文件就可以访问了

随便写一篇文章是不是轻轻松松

a45ce86335ce

 

请登录后发表评论

    没有回复内容