如何使用docsify搭建本身的github文档？

时间 2021-02-18

标签 css html vue java node git github chrome shell npm 栏目 Git 繁體版

原文原文链接

安装前提

确认电脑已经安装好 node 和 npm 环境。若是尚未装好，那须要执行下面的步骤：
1.进入官网：https://nodejs.org/zh-cn/ ，下载长期支持版。
css

2.安装就直接下一步就能够了，默认会把环境变量添加进去。
html

3.直到finish，打开cmd命令行，查看环境变量以及版本。（此时大家看到的应该仍是只把node.js的根目录添加到环境变量path）
vue

4.运行命令修改npm的文件夹前缀和缓存目录,配置镜像站。java

npm config set prefix "D:\nodejs\node_global"
npm config set cache "D:\nodejs\node_cache"
npm config set registry=http://registry.npm.taobao.org

而后使用npm config list就能够看到本身的配置：
node

还须要增长一个环境变量，是node的modules的环境变量(个人nodejs在D盘根目录下，大家的要本身根据实际状况)：git

D:\nodejs\node_global\node_modules

5.而后若是使用npm安装了东西，可是找不到该命令，则还须要在Path中，把咱们node的全局文件夹添加进去环境变量中。github

D:\nodejs\node_global

这样咱们就能够愉快的安装东西了。chrome

docsify走起

官网：
https://docsify.js.org/#/shell

废话我就很少说了，直接安装docsify-cli :npm

npm i docsify-cli -g

而后咱们创建一个测试文件夹叫note，命令行进入这个文件夹：

cd note
docsify init ./docs

就成功了！！！看到它叫你执行命令,本地启动一下：

docsify serve ./docs

这样就能够在本地http://localhost:3000打开了，神奇~（修改内容后保存就能够，不须要从新启动）

美化一下

说实在话，挺丑的，那就美化一下：
先加一个封面，须要在`index.html中，把下面的属性设置为true

coverpage: true

而后新建一个文件_coverpage.md:

# Mybatis摸索之路


> 这是我本身的笔记啊啊啊啊

[CSDN](https://blog.csdn.net/Aphysia)
[滚动鼠标](#introduction)

而后它就变成这样了：

咱们还须要一个侧边栏，再将侧边栏属性打开：

loadSidebar: true

而后新建一个侧边栏的文件_sidebar.md:

- Note

  - [第一章节](第一章节.md)
  - [第二章节](第二章节.md)
  - [第三章节](第三章节.md)

而后就变成这样了：

其中中间那部分使用的是README.md的内容，其余的index.html的内容以下(本身根据须要设置，若是有更高级的需求，建议去官网查文档！！！)

<!DOCTYPE html>
<html lang="en">

<head>
  <meta charset="UTF-8">
  <title>docsify-demo</title>
  <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
  <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/lib/themes/vue.css">
</head>

<body>
  <div id="app"></div>
  <!-- docsify-edit-on-github -->
  <script src="//unpkg.com/docsify-edit-on-github/index.js"></script>
  <!--Java代码高亮-->
  <script src="//unpkg.com/prismjs/components/prism-java.js"></script>
 <!--全文搜索,直接用官方提供的没法生效-->
 <script src="https://cdn.bootcss.com/docsify/4.5.9/plugins/search.min.js"></script>
 <!-- 复制代码到剪贴板 -->
  <script src="//unpkg.com/docsify-copy-code"></script>
  <!-- 图片缩放 -->
  <script src="//unpkg.com/docsify/lib/plugins/zoom-image.js"></script>
  <!-- 字数统计 -->
  <script src="//unpkg.com/docsify-count/dist/countable.js"></script> 
  <script>
    window.$docsify = {
      name: 'docsify-demo',
      repo: 'https://github.com/Damaer/Mybatis-Learning',
      maxLevel: 5,//最大支持渲染的标题层级
      subMaxLevel: 3,
      homepage: 'README.md',
      coverpage: true,
      loadSidebar: true,
      auto2top: true,//切换页面后是否自动跳转到页面顶部
       //全文搜索
       search: {
        maxAge: 86400000, // 过时时间，单位毫秒，默认一天
        paths: 'auto',
        placeholder: '搜索',
        noData: '找不到结果',
        // 搜索标题的最大程级, 1 - 6
        depth: 3,
      }
    }
  </script>
  <script src="//unpkg.com/docsify/lib/docsify.min.js"></script>
</body>

</html>

如何部署到github

下面讲讲如何部署，首先咱们须要有一个远程的仓库，我默认你有了，使用命令初始化文件夹，关联远程仓库

git init
git remote add origin "本身在三方代码托管平台上所建立仓库对应的地址"

push代码到远程仓库就能够了，git的操做就不仔细讲了，或者本身把远程的仓库先clone下来，再用docsify建立文档，而后提交，也是ok的。

提交上去以后，咱们须要作一个操做，在settings下有一个GitHub Pages,选择构建分支和文件目录便可。我使用的是master，根目录的docs文件夹。而后你就能够看到已经发布成功了，直接访问网址就能够。

PS：项目是个人其余项目地址，可是流程是一致的。

坑点

我打不开网址！！！是由于电信会屏蔽一些网站，也就是被qiang了，懂的都懂，若是要访问的话，能够修改DNS，或者搞一把梯_子。

【做者简介】：
秦怀，公众号【秦怀杂货店】做者，技术之路不在一时，山高水长，纵使缓慢，驰而不息。这个世界但愿一切都很快，更快，可是我但愿本身能走好每一步，写好每一篇文章，期待和大家一块儿交流。