摘要:介紹是一個動態生成文檔網站的工具。不同于的地方是它不會生成將轉成文件,所有轉換工作都是在運行時進行。使用來開發工具,可以方便創建及本地預覽文檔網站。
1. docsify介紹
docsify 是一個動態生成文檔網站的工具。不同于 GitBook、Hexo 的地方是它不會生成將 .md 轉成 .html 文件,所有轉換工作都是在運行時進行。
這將非常實用,如果只是需要快速的搭建一個小型的文檔網站,或者不想因為生成的一堆 .html 文件“污染” commit 記錄,只需要創建一個 index.html 就可以開始寫文檔而且直接部署在 GitHub Pages。
2. 引入docsify方式 2.1 手動創建index.html并引入docsify文件docsify使用方式很簡單,只需要在項目中創建一個index.html文件,內容能夠如下:
然后在項目中創建一個README.md文件:
## 我是首頁 這是我的首頁介紹
如果你的系統安裝了Python 的話,可以使用Python來啟動一個服務:
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/查看瀏覽效果。
如果沒有Python,還是可以使用http-server啟動服務,
可在終端輸入npm install http-server -g來安裝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來開發注意:
1.在此模式下編輯文件保存后,需要手動刷新瀏覽器才能看見修改的效果,下面介紹的docsify-cli可實現自動查看效果。
2.強烈建議把index.htm文件中的docsify.min.js和vue.css文件復制到本地項目,然后使用如下方式引入:這樣做的好處是不在依賴網絡環境了。
docsify-cli 工具,可以方便創建及本地預覽文檔網站。
2.2.1 安裝docsify需要本地先安裝node, 如果沒有安裝node,可在node官網選擇對應操作系統下載安裝:https://nodejs.org/zh-cn/
終端輸入npm i docsify-cli -g進行全局安裝:
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
文章版權歸作者所有,未經允許請勿轉載,若此文章存在違規行為,您可以聯系管理員刪除。
轉載請注明本文地址:http://m.specialneedsforspecialkids.com/yun/100563.html
摘要:你可以指定導航欄文件名的內容可以是這樣中文當然也支持二級列表,將生成一個下拉列表中文為什么是而不用想要實現的是用最簡單的方式動態渲染內容。 showImg(https://segmentfault.com/img/bVGh1i?w=2562&h=1972); docsify 無需構建快速生成文檔頁 網站:https://github.com/qingwei-li...文檔:https:...
摘要:你可以指定導航欄文件名的內容可以是這樣中文當然也支持二級列表,將生成一個下拉列表中文為什么是而不用想要實現的是用最簡單的方式動態渲染內容。 showImg(https://segmentfault.com/img/bVGh1i?w=2562&h=1972); docsify 無需構建快速生成文檔頁 網站:https://github.com/qingwei-li...文檔:https:...
摘要:說明是一個基于和開發的評論插件。默認值類型布爾值,選填,類似評論框的全屏遮罩效果。默認值類型布爾值,選填,如果當前頁面沒有相應的且登錄的用戶屬于,則會自動創建。參考類型布爾值,選填,啟用快捷鍵提交評論。 1. 說明 Gitalk 是一個基于 GitHub Issue 和 Preact 開發的評論插件。 Gitalk 的特性: 1、使用 GitHub 登錄2、支持多語言 [en, zh-...
摘要:前端切圖神器前端掘金安裝前端的基礎工作就是把設計師的設計稿還原成前端頁面,所以切圖是作為一個前端的基本技能。 騰訊 Web 工程師的前端書單 - 閱讀 - 掘金作者:link 2014年一月以來,自己接觸web前端開發已經兩年多了,記錄一下自己前端學習路上看過的,以及道聽途說的一些書,基本上按照由淺入深來介紹。 JavaScript 入門 《JavaScript權威指南(第六版)》 ★...
閱讀 1646·2023-04-26 02:11
閱讀 2990·2023-04-25 16:18
閱讀 3720·2021-09-06 15:00
閱讀 2636·2019-08-30 15:55
閱讀 1942·2019-08-30 13:20
閱讀 2058·2019-08-26 18:36
閱讀 3131·2019-08-26 11:40
閱讀 2549·2019-08-26 10:11