Git   发布时间:2019-10-25  发布网站:大佬教程  code.js-code.com
大佬教程收集整理的这篇文章主要介绍了docsify网站文档工具用法总结大佬教程大佬觉得挺不错的,现在分享给大家,也给大家做个参考。

  • 无需构建,写完文档直接发布
  • 容易使用并且轻量 (~19kB gzipped)
  • 智能的全文搜索
  • 提供多套主题
  • 丰富的 API
  • 支持 Emoji
  • 兼容 IE10+
  • 支持 SSR

npm i docsify-cli -g
@H_772_24@进入项目根目录并初始化

docsify init ./docs
@H_772_24@之后docs目录下会生成以下几个文件

index.html 入口文件
README.md 会做为主页内容渲染
.nojekyll 用于阻止 GitHub Pages 会忽略掉下划线开头的文件
@H_772_24@运行服务

docsify serve ./docs
@H_772_24@打开浏览器

创建多个页面,或者多级路由。创建一个 guide.md 文件,那么对应的路由就是 /#/guide。

例如这样一个目录结构

-| docs/
  -| README.md
  -| guide.md
  -| zh-cn/
    -| README.md
    -| guide.md

docs/README.md => http://domain.com
docs/guide.md => http://domain.com/guide
docs/zh-cn/README.md => http://domain.com/zh-cn/
docs/zh-cn/guide.md => http://domain.com/zh-cn/guide


<h3 id="设置封面">设置封面

@H_772_24@设置 coverpage 参数

window.$docsify = {
    coverpage: true
  }
@H_772_24@接着在根目录创建 _coverpage.md 文件

@H_772_24@默认的背景是随机生成的渐变色

@H_772_24@如要自定义背景图片或者背景色,在_coverpage.md中设置如下内容


@H_772_24@

@H_772_24@color

<h3 id="自定义导航栏">自定义导航栏

@H_772_24@直接在 HTML 里定义导航栏,链接以 #/ 开头

@H_772_24@在index.html的body中添加以下代码


  
@H_772_24@接着配置 loadNavbar

window.$docsify = {
    loadNavbar: true
  }
@H_772_24@在Navbar.md_中添加以下链接

* [En](/)
* [中文](/zh-cn/)

@H_772_24@默认侧边栏会根据当前文档的标题生成目录。也可以设置文档链接,通过 Markdown 文件生成

@H_772_24@先配置 loadSidebar 选项

window.$docsify = {
    loadSidebar: true
  }
@H_772_24@然后创建 _sidebar.md 文件,这样我们左侧目录就会显示出来

* [首页](zh-cn/)
* [指南](zh-cn/guidE)
@H_772_24@需要在文档根目录创建 .nojekyll 命名的空文件,阻止 GitHub Pages 忽略命名是下划线开头的文件。

@H_772_24@添加全文搜索 引入search.js


<script src="//unpkg.com/gitalk/dist/gitalk.min.js">

clientID和clientSecret需要在github上创建一个app生成

大佬总结

以上是大佬教程为你收集整理的docsify网站文档工具用法总结全部内容,希望文章能够帮你解决docsify网站文档工具用法总结所遇到的程序开发问题。

如果觉得大佬教程网站内容还不错,欢迎将大佬教程推荐给程序员好友。

本图文内容来源于网友网络收集整理提供,作为学习参考使用,版权属于原作者。
如您有任何意见或建议可联系处理。小编QQ:384754419,请注明来意。
标签: