基本参照官方文档部署


部署Docsify

基本上就是按照官方文档操作了

  • 全局安装docsify-cli工具
    ```bash npm i docsify-cli -g

ln -s /usr/local/temp/Node.js/bin/docsify /usr/bin/docsify

  1. - 初始化项目,选择自己喜欢的位置,最好就按照官方命令,方便以后操作
  2. ```bash
  3. docsify init ./docs

配置说明

配置集中在index.html文件当中,这里摘取本文档所用到的插件进行分解解释

  1. <!DOCTYPE html>
  2. <html lang="zh-CN">
  3. <head>
  4. <meta charset="UTF-8">
  5. <title>Document</title>
  6. <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
  7. <meta name="description" content="Description">
  8. <meta name="viewport" content="width=device-width, initial-scale=1.0, minimum-scale=1.0">
  9. <link rel="stylesheet" href="//unpkg.com/docsify/lib/themes/vue.css">
  10. <link rel="stylesheet" href="//cdn.jsdelivr.net/npm/gitalk/dist/gitalk.css">
  11. </head>
  12. <body>
  13. <div id="app"></div>
  14. <script>
  15. //插件的配置都写在这里
  16. window.$docsify = {
  17. //图标
  18. logo:'',
  19. //整个网站的名字
  20. name:'Dy\'s Doc',
  21. //右上角github链接地址
  22. repo:'https://github.com/JuemingDy',
  23. // 导航栏,需要有_navbar.md文件
  24. loadNavbar: true,
  25. // 封面,需要有_coverpage.md文件
  26. coverpage: true,
  27. //侧边栏,需要有_sidebar.md文件
  28. loadSidebar: true,
  29. //开启侧边栏后不再自动生成目录,需要开启此项决定生成多少级
  30. subMaxLevel: 2,
  31. // 404页
  32. notFoundPage:'_404.md',
  33. //代码复制插件
  34. copyCode: {
  35. buttonText : '点击复制',
  36. errorText : '发生错误',
  37. successText: '已复制'
  38. },
  39. //谷歌统计,需要服务器能链接外网
  40. //ga: 'UA-207767065-1',
  41. //字数统计
  42. count:{
  43. countable:true,
  44. fontsize:'0.9em',
  45. color:'rgb(90,90,90)',
  46. language:'chinese',
  47. },
  48. //搜索
  49. search: 'auto',
  50. search: {
  51. paths: '/',
  52. placeholder: '搜索',
  53. noData: '找不到结果',
  54. depth: 3,
  55. },
  56. //tab插件
  57. tabs: {
  58. persist : true, // default
  59. sync : true, // default
  60. theme : 'classic', // default
  61. tabComments: true, // default
  62. tabHeadings: true // default
  63. },
  64. //分页
  65. /*
  66. pagination: {
  67. previousText: '上一篇',
  68. nextText: '下一篇',
  69. crossChapter: true,
  70. crossChapterText: true,
  71. },
  72. */
  73. //脚
  74. footer: {
  75. copy: 'Copyright©2021 ,',
  76. auth: 'DyCloud',
  77. pre: '<hr>',
  78. style:'text-align: center;'
  79. },
  80. }
  81. </script>
  82. <!--cdn地址,按自己喜欢的选-->
  83. <!--<script src="//cdn.jsdelivr.net/npm/docsify/lib/docsify.min.js"></script>-->
  84. <!--<script src="//cdnjs.cloudflare.com/ajax/libs/docsify/4.11.2/docsify.min.js"></script>-->
  85. <!--<script src="//unpkg.com/docsify/lib/docsify.min.js"></script>-->
  86. <!-- Docsify,不能少的 -->
  87. <script src="//unpkg.com/docsify/lib/docsify.min.js"></script>
  88. <!-- emoji -->
  89. <script src="//unpkg.com/docsify/lib/plugins/emoji.min.js"></script>
  90. <!-- 复制到剪贴板 -->
  91. <script src="//unpkg.com/docsify-copy-code@"></script>
  92. <!-- 图片缩放 -->
  93. <script src="//cdn.jsdelivr.net/npm/docsify/lib/plugins/zoom-image.min.js"></script>
  94. <!-- 代码高亮 -->
  95. <script src="//unpkg.com/prismjs/components/prism-bash.min.js"></script>
  96. <script src="//unpkg.com/prismjs/components/prism-php.min.js"></script>
  97. <!-- 谷歌统计 -->
  98. <!--<script src="//unpkg.com/docsify/lib/plugins/ga.min.js"></script>-->
  99. <!-- 字数统计 -->
  100. <script src="//unpkg.com/docsify-count/dist/countable.js"></script>
  101. <!-- 搜索 -->
  102. <script src="//unpkg.com/docsify/lib/plugins/search.min.js"></script>
  103. <!-- 标签 -->
  104. <script src="https://cdn.jsdelivr.net/npm/docsify-tabs@1"></script>
  105. <!-- 分页 -->
  106. <!--<script src="//unpkg.com/docsify-pagination/dist/docsify-pagination.min.js"></script>-->
  107. <!-- 脚 -->
  108. <script src="//unpkg.com/docsify-footer-enh/dist/docsify-footer-enh.min.js"></script>
  109. <!-- git评论 -->
  110. <script src="//cdn.jsdelivr.net/npm/docsify/lib/plugins/gitalk.min.js"></script>
  111. <script src="//cdn.jsdelivr.net/npm/gitalk/dist/gitalk.min.js"></script>
  112. <script>
  113. var gitalk = new Gitalk({
  114. clientID: '406162e419988e219faf',
  115. clientSecret: '77ae615c44b9ab0c08b7e0ae097d0d11ae7bd9f0',
  116. repo: 'Dy-s-Docsify',
  117. owner: 'JuemingDy',
  118. admin: ['JuemingDy'],
  119. id: location.pathname,
  120. distractionFreeMode: true
  121. })
  122. </script>
  123. <!-- 离线模式 -->
  124. <script>
  125. if (typeof navigator.serviceWorker !== 'undefined') {
  126. navigator.serviceWorker.register('sw.js')
  127. }
  128. </script>
  129. </body>
  130. </html>