docsify基本功能介紹

作者：contr4l_

一個神奇的文件網站生成器。

關於 Docsify 的介紹請見docsify，在此不再贅述，讀者可以簡單理解為這個工具將編排有序的文件組織為一個網站並對外提供服務。

docsify 的安裝#

Node.js 安裝#

官方下載地址為Node.js，通常建議下載LTS版本。

注意安裝過程中如果有是否將 node/npm 添加至環境變量的選項需要勾上。 Add xxx to environment PATH

確認安裝結果：Win+R輸入powershell並回車，打開Windows PowerShell，輸入npm -v，輸出結果應如下所示。

PS C:\Users\ctrl> npm -v
9.5.0
# 根據用戶的node.js版本不同，數字可能有所差異

docsify 安裝#

docsify 實際上是受 npm 管理的一個框架，因此我們需要使用 npm 來安裝 docsify。

npm i docsify-cli -g
# PS C:\Users\ctrl> npm i docsify-cli -g
# added 204 packages in 33s
# 16 packages are looking for funding
#   run `npm fund` for details

# 如果是linux系統，請使用sudo npm i docsify -g

將 docsify 的路徑加入系統環境變量中後，一路確定關掉設置窗口。

注意此處環境變量的路徑要根據自己系統中 docsify.ps1 所在的位置確定，每個人是不一樣的

使用管理員權限打開 powershell 並輸入set-ExecutionPolicy RemoteSigned增加自定義腳本執行權限。


# PS C:\WINDOWS\system32> set-ExecutionPolicy RemoteSigned
# 執行策略更改
# 執行策略可幫助你防止執行不信任的腳本。更改執行策略可能會產生安全風險，如 https:/go.microsoft.com/fwlink/?LinkID=135170
# 中的 about_Execution_Policies 幫助主題所述。是否要更改執行策略?
# [Y] 是(Y)  [A] 全是(A)  [N] 否(N)  [L] 全否(L)  [S] 暫停(S)  [?] 幫助 (預設值為“N”): 

# **輸入A然後回車**

執行docsify測試結果

PS C:\WINDOWS\system32> docsify
Usage: docsify <init|serve> <path>

Commands:
  docsify init [path]      創建新的文檔                         [aliases: i]
  docsify serve [path]     運行本地服務器以預覽網站。        [aliases: s]
  docsify start <path>     Server for SSR
  docsify generate <path>  Docsify's generators                     [aliases: g]

Global Options
  --help, -h     顯示幫助                                             [boolean]
  --version, -v  顯示版本號                                           [boolean]

使用 docsify 生成網頁#

# 切換到gh-pages分支
PS C:\Users\ctrl\Desktop\TornCity\TornCity-CnWiki> git checkout gh-pages
Switched to a new branch 'gh-pages'
branch 'gh-pages' set up to track 'origin/gh-pages'.

# docsify生成網頁
PS C:\Users\ctrl\Desktop\TornCity\TornCity-CnWiki> docsify serve ./

Serving C:\Users\ctrl\Desktop\TornCity\TornCity-CnWiki now.
Listening at http://localhost:3000

# 最後在瀏覽器中訪問http://localhost:3000查看效果