簡介

在日常開發(fā)中 前后端對接時 經(jīng)常要寫很多文檔Api。docsify就是一個強大的文檔生成工具 界面清新好 支持語法高亮和Markdown 語法，并且docsify 擴展了一些 Markdown 語法可以讓文檔更易讀。像vue.js官網(wǎng)(https://cn.vuejs.org/)就是docsify 其中的一種注意 并且是目前用的的最多的主題

效果圖如下

預覽鏈接：https://a870439570.github.io/interview-docs

image

image

快速開始

首先先安裝好npm和nodejs,這里就不做過多介紹了 自信安裝即可 （https://blog.csdn.net/zimushuang/article/details/79715679）

安裝docsify 推薦安裝 docsify-cli 工具，可以方便創(chuàng)建及本地預覽文檔網(wǎng)站。

npm i docsify-cli -g

初始化項目

# 進入指定文件目錄 如下：F:\ideWork\githubWork\test_docs 
運行    docsify init ./docs

image

初始化成功后，可以看到 ./docs 目錄下創(chuàng)建的幾個文件

index.html 入口文件
README.md 會做為主頁內(nèi)容渲染
.nojekyll 用于阻止 GitHub Pages 會忽略掉下劃線開頭的文件

image

本地預覽網(wǎng)站

運行一個本地服務器通過 docsify serve 可以方便的預覽效果，而且提供 LiveReload 功能，可以讓實時的預覽。默認訪問http://localhost:3000/#/。

docsify serve docs

一個基本的文檔網(wǎng)站就搭建好了，docsify還可以自定義導航欄，自定義側(cè)邊欄以及背景圖和一些開發(fā)插件等等
更多配置請參考官方文檔 https://docsify.js.org/#/zh-cn/quickstart

下面介紹docsify如何部署到Github 使用免費的站點

和 GitBook 生成的文檔一樣，我們可以直接把文檔網(wǎng)站部署到 GitHub Pages 或者 VPS 上

GitHub Pages

GitHub Pages 支持從三個地方讀取文件

• docs/ 目錄
• master 分支
• gh-pages 分支

上傳文件至Github倉庫 官方推薦直接將文檔放在 docs/ 目錄下，在設置頁面開啟 GitHub Pages 功能并選擇 master branch /docs folder 選項。

在這里插入圖片描述

此時等待幾秒鐘 就可以訪問了 我這里使用了自定義域名

Github如何配置自定義域名

在根目錄下創(chuàng)建CNAME文件 并配置你的阿里云或其它網(wǎng)站購買的域名

在這里插入圖片描述

設置頁面 Custom domain 更改域名

在這里插入圖片描述

進入域名平臺 進行解析 添加繼續(xù)記錄 ；類型為CNAME

在這里插入圖片描述

解析后 等待十分鐘既可開啟了

官方文檔 https://docsify.js.org/#/zh-cn/quickstart
預覽鏈接：https://a870439570.github.io/interview-docs
個人博客：https://blog.qinxuewu.club/