教你如何使用docsify快速部署優美的在線文檔


效果演示

推薦一個非常牛的文檔網站生成器:docsify

我通過這個工具,成功將碼雲上的個人學習筆記發布到GiteePages上,有興趣的小伙伴可以戳一戳:https://tqbx.gitee.io/javablog/

話不多說,直接上圖,文檔效果如下:

主頁README.md

文章詳情頁

咋樣,默認風格綠色小清新,給我的體驗非常nice。除此之外,它還提供許多非常強大的可定制的內容,最主要的是,你只需要敲幾行命令就可以快速啟動了!

如果你也想擁有一個這樣的文檔網站,可以查看官方網站:https://docsify.js.org/#/zh-cn/quickstart,講解十分詳細,當然,本文也會做一定的記錄。ok,讓我們開始吧。

快速開始

為了演示,我們事先新建一個目錄docsify用來存放待會要下載的內容。

進入docsify目錄,打開命令行全局安裝 docsify-cli 工具,可以方便地創建及在本地預覽生成的文檔。

$ npm i docsify-cli -g # 前提要安裝好npm環境

初始化項目,我們直接在當前目錄下初始化。

$ docsify init

初始化成功后,我們可以看到docsify目錄下多出三個文件:

  • index.html 入口文件
  • README.md 會做為主頁內容渲染
  • .nojekyll 用於阻止 GitHub Pages 忽略掉下划線開頭的文件

運行如下命令啟動本地服務器,實時預覽文檔效果。

$ docsify serve # 默認啟動當前目錄,docsify serve docs表示啟動當前目錄下的docs目錄

ok,接着訪問:localhost:3000/,成功出現以下內容。

個性化定制

當然了,運行成功之后,你難免會想方設法去做一些適合自己的定制,比如代碼高亮,鏈接,搜索,字數統計等等功能,你可以按照官網的文檔,逐一添加自己喜歡的插件,在剛剛生成的index.html中定制。

我稍微做一下演示,拋磚引玉。

比如,假設我想讓我的網站名顯示,並且右上角標注github圖標

  <script>
    window.$docsify = {
      name: '天喬巴夏',
      repo: 'https://github.com/TQBX'
    }
  </script>

如果你想要統計字數並顯示,你可以添加如下插件:

<script src="//unpkg.com/docsify-count/dist/countable.js"></script>

並進行如下設置:

window.$docsify = {
  count:{
    countable:true,
    fontsize:'0.9em',
    color:'rgb(90,90,90)',
    language:'chinese'
  }
}

更多插件:https://docsify.js.org/#/zh-cn/plugins

如果你想更換主題,你可以更改css引入:

<link rel="stylesheet" href="//cdn.jsdelivr.net/npm/docsify/themes/vue.css">
<link rel="stylesheet" href="//cdn.jsdelivr.net/npm/docsify/themes/buble.css">
<link rel="stylesheet" href="//cdn.jsdelivr.net/npm/docsify/themes/dark.css">
<link rel="stylesheet" href="//cdn.jsdelivr.net/npm/docsify/themes/pure.css">
<link rel="stylesheet" href="//cdn.jsdelivr.net/npm/docsify/themes/dolphin.css">

部署

部署的方式很多,這里使用Gitee的GiteePages,沒啥的,就是國內訪問的速度更快一點。

我們創建倉庫並上傳文件,點擊服務,選擇GiteePages

強制使用HTTPS,選擇部署目錄,默認為整個倉庫。

接着訪問生成的url即可: https://tqbx.gitee.io/test-docsify

注意,每次上傳更新代碼,服務不會自動更新,需要手動更新。


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM