js预览本地word文档_Github+docsify打造在线文档
效果圖如下
預(yù)覽鏈接:https://a870439570.github.io/interview-docs
快速開(kāi)始
首先先安裝好npm和nodejs,這里就不做過(guò)多介紹了 自信安裝即可 (https://blog.csdn.net/zimushuang/article/details/79715679)
安裝docsify 推薦安裝 docsify-cli 工具,可以方便創(chuàng)建及本地預(yù)覽文檔網(wǎng)站。
npm i docsify-cli -g初始化項(xiàng)目
# 進(jìn)入指定文件目錄 如下:F:ideWorkgithubWorkest_docs 運(yùn)行 docsify init ./docs初始化成功后,可以看到 ./docs 目錄下創(chuàng)建的幾個(gè)文件index.html 入口文件README.md 會(huì)做為主頁(yè)內(nèi)容渲染.nojekyll 用于阻止 GitHub Pages 會(huì)忽略掉下劃線開(kāi)頭的文件本地預(yù)覽網(wǎng)站
運(yùn)行一個(gè)本地服務(wù)器通過(guò) docsify serve 可以方便的預(yù)覽效果,而且提供 LiveReload 功能,可以讓實(shí)時(shí)的預(yù)覽。默認(rèn)訪問(wèn)http://localhost:3000/#/。
docsify serve docs一個(gè)基本的文檔網(wǎng)站就搭建好了,docsify還可以自定義導(dǎo)航欄,自定義側(cè)邊欄以及背景圖和一些開(kāi)發(fā)插件等等
更多配置請(qǐng)參考官方文檔 https://docsify.js.org/#/zh-cn/quickstart
下面介紹docsify如何部署到Github 使用免費(fèi)的站點(diǎn)
和 GitBook 生成的文檔一樣,我們可以直接把文檔網(wǎng)站部署到 GitHub Pages 或者 VPS 上
GitHub Pages
GitHub Pages 支持從三個(gè)地方讀取文件
- docs/ 目錄
- master 分支
- gh-pages 分支
上傳文件至Github倉(cāng)庫(kù) 官方推薦直接將文檔放在 docs/ 目錄下,在設(shè)置頁(yè)面開(kāi)啟 GitHub Pages 功能并選擇 master branch /docs folder 選項(xiàng)。
在這里插入圖片描述
此時(shí)等待幾秒鐘 就可以訪問(wèn)了 我這里使用了自定義域名
Github如何配置自定義域名
在根目錄下創(chuàng)建CNAME文件 并配置你的阿里云或其它網(wǎng)站購(gòu)買(mǎi)的域名
在這里插入圖片描述
設(shè)置頁(yè)面 Custom domain 更改域名
在這里插入圖片描述
進(jìn)入域名平臺(tái) 進(jìn)行解析 添加繼續(xù)記錄 ;類(lèi)型為CNAME
在這里插入圖片描述
解析后 等待十分鐘既可開(kāi)啟了
原文鏈接 https://blog.qinxuewu.club/
預(yù)覽鏈接:https://a870439570.github.io/interview-docs
總結(jié)
以上是生活随笔為你收集整理的js预览本地word文档_Github+docsify打造在线文档的全部?jī)?nèi)容,希望文章能夠幫你解決所遇到的問(wèn)題。
- 上一篇: python的request请求401_
- 下一篇: eeg数据集_运动想象,情绪识别等公开数