摘要:介紹是一個(gè)動(dòng)態(tài)生成文檔網(wǎng)站的工具。不同于的地方是它不會(huì)生成將轉(zhuǎn)成文件,所有轉(zhuǎn)換工作都是在運(yùn)行時(shí)進(jìn)行。使用來(lái)開(kāi)發(fā)工具,可以方便創(chuàng)建及本地預(yù)覽文檔網(wǎng)站。
1. docsify介紹
docsify 是一個(gè)動(dòng)態(tài)生成文檔網(wǎng)站的工具。不同于 GitBook、Hexo 的地方是它不會(huì)生成將 .md 轉(zhuǎn)成 .html 文件,所有轉(zhuǎn)換工作都是在運(yùn)行時(shí)進(jìn)行。
這將非常實(shí)用,如果只是需要快速的搭建一個(gè)小型的文檔網(wǎng)站,或者不想因?yàn)樯傻囊欢?.html 文件“污染” commit 記錄,只需要?jiǎng)?chuàng)建一個(gè) index.html 就可以開(kāi)始寫文檔而且直接部署在 GitHub Pages。
2. 引入docsify方式 2.1 手動(dòng)創(chuàng)建index.html并引入docsify文件docsify使用方式很簡(jiǎn)單,只需要在項(xiàng)目中創(chuàng)建一個(gè)index.html文件,內(nèi)容能夠如下:
然后在項(xiàng)目中創(chuàng)建一個(gè)README.md文件:
## 我是首頁(yè) 這是我的首頁(yè)介紹
如果你的系統(tǒng)安裝了Python 的話,可以使用Python來(lái)啟動(dòng)一個(gè)服務(wù):
python -m SimpleHTTPServer 3000 Serving HTTP on 0.0.0.0 port 3000 ... 127.0.0.1 - - [03/Jan/2019 13:45:27] "GET / HTTP/1.1" 200 -
然后在瀏覽器中輸入http://localhost:3000/查看瀏覽效果。
如果沒(méi)有Python,還是可以使用http-server啟動(dòng)服務(wù),
可在終端輸入npm install http-server -g來(lái)安裝http-server。
http-server Starting up http-server, serving ./ Available on: http://127.0.0.1:8080 http://172.24.70.142:8080 Hit CTRL-C to stop the server
然后在瀏覽器中輸入http://127.0.0.1:8080查看瀏覽效果。
2.2 使用docsify-cli來(lái)開(kāi)發(fā)注意:
1.在此模式下編輯文件保存后,需要手動(dòng)刷新瀏覽器才能看見(jiàn)修改的效果,下面介紹的docsify-cli可實(shí)現(xiàn)自動(dòng)查看效果。
2.強(qiáng)烈建議把index.htm文件中的docsify.min.js和vue.css文件復(fù)制到本地項(xiàng)目,然后使用如下方式引入:這樣做的好處是不在依賴網(wǎng)絡(luò)環(huán)境了。
docsify-cli 工具,可以方便創(chuàng)建及本地預(yù)覽文檔網(wǎng)站。
2.2.1 安裝docsify需要本地先安裝node, 如果沒(méi)有安裝node,可在node官網(wǎng)選擇對(duì)應(yīng)操作系統(tǒng)下載安裝:https://nodejs.org/zh-cn/
終端輸入npm i docsify-cli -g進(jìn)行全局安裝:
npm i docsify-cli -g /usr/local/bin/docsify -> /usr/local/lib/node_modules/docsify-cli/bin/docsify > fsevents@1.2.4 install /usr/local/lib/node_modules/docsify-cli/node_modules/fsevents > node install [fsevents] Success: "/usr/local/lib/node_modules/docsify-cli/node_modules/fsevents/lib/binding/Release/node-v57-darwin-x64/fse.node" already installed Pass --update-binary to reinstall or --build-from-source to recompile > docsify@4.8.6 postinstall /usr/local/lib/node_modules/docsify-cli/node_modules/docsify > opencollective postinstall Thanks for installing docsify
文章版權(quán)歸作者所有,未經(jīng)允許請(qǐng)勿轉(zhuǎn)載,若此文章存在違規(guī)行為,您可以聯(lián)系管理員刪除。
轉(zhuǎn)載請(qǐng)注明本文地址:http://specialneedsforspecialkids.com/yun/100563.html
摘要:你可以指定導(dǎo)航欄文件名的內(nèi)容可以是這樣中文當(dāng)然也支持二級(jí)列表,將生成一個(gè)下拉列表中文為什么是而不用想要實(shí)現(xiàn)的是用最簡(jiǎn)單的方式動(dòng)態(tài)渲染內(nèi)容。 showImg(https://segmentfault.com/img/bVGh1i?w=2562&h=1972); docsify 無(wú)需構(gòu)建快速生成文檔頁(yè) 網(wǎng)站:https://github.com/qingwei-li...文檔:https:...
摘要:你可以指定導(dǎo)航欄文件名的內(nèi)容可以是這樣中文當(dāng)然也支持二級(jí)列表,將生成一個(gè)下拉列表中文為什么是而不用想要實(shí)現(xiàn)的是用最簡(jiǎn)單的方式動(dòng)態(tài)渲染內(nèi)容。 showImg(https://segmentfault.com/img/bVGh1i?w=2562&h=1972); docsify 無(wú)需構(gòu)建快速生成文檔頁(yè) 網(wǎng)站:https://github.com/qingwei-li...文檔:https:...
摘要:說(shuō)明是一個(gè)基于和開(kāi)發(fā)的評(píng)論插件。默認(rèn)值類型布爾值,選填,類似評(píng)論框的全屏遮罩效果。默認(rèn)值類型布爾值,選填,如果當(dāng)前頁(yè)面沒(méi)有相應(yīng)的且登錄的用戶屬于,則會(huì)自動(dòng)創(chuàng)建。參考類型布爾值,選填,啟用快捷鍵提交評(píng)論。 1. 說(shuō)明 Gitalk 是一個(gè)基于 GitHub Issue 和 Preact 開(kāi)發(fā)的評(píng)論插件。 Gitalk 的特性: 1、使用 GitHub 登錄2、支持多語(yǔ)言 [en, zh-...
摘要:前端切圖神器前端掘金安裝前端的基礎(chǔ)工作就是把設(shè)計(jì)師的設(shè)計(jì)稿還原成前端頁(yè)面,所以切圖是作為一個(gè)前端的基本技能。 騰訊 Web 工程師的前端書(shū)單 - 閱讀 - 掘金作者:link 2014年一月以來(lái),自己接觸web前端開(kāi)發(fā)已經(jīng)兩年多了,記錄一下自己前端學(xué)習(xí)路上看過(guò)的,以及道聽(tīng)途說(shuō)的一些書(shū),基本上按照由淺入深來(lái)介紹。 JavaScript 入門 《JavaScript權(quán)威指南(第六版)》 ★...
閱讀 1644·2023-04-26 02:11
閱讀 2985·2023-04-25 16:18
閱讀 3717·2021-09-06 15:00
閱讀 2636·2019-08-30 15:55
閱讀 1938·2019-08-30 13:20
閱讀 2054·2019-08-26 18:36
閱讀 3129·2019-08-26 11:40
閱讀 2543·2019-08-26 10:11