一、WikiDocs介紹

1.1 WikiDocs 簡(jiǎn)介

WikiDocs 是一款開源的、無需數(shù)據(jù)庫的 Markdown 靜態(tài)文件 Wiki 引擎，以純文本文件為基礎(chǔ)存儲(chǔ)內(nèi)容，輕量高效，適合個(gè)人知識(shí)管理與團(tuán)隊(duì)文檔協(xié)作。

1.2 WikiDocs 主要特點(diǎn)

• 開源：代碼完全開放，便于審查、定制和自由使用。
• 純文本文件：所有內(nèi)容以普通文件形式保存，便于版本控制和備份。
• 無需數(shù)據(jù)庫：直接讀寫文件系統(tǒng)，部署簡(jiǎn)單，維護(hù)成本低。
• Markdown 語法：使用標(biāo)準(zhǔn) Markdown 編寫內(nèi)容，簡(jiǎn)潔易讀易寫。
• 編輯器全功能所見即所得（WYSIWYG）：實(shí)時(shí)預(yù)覽編輯效果，提升寫作體驗(yàn)。
• 支持?jǐn)?shù)學(xué)公式 KaTeX：輕松渲染復(fù)雜的數(shù)學(xué)表達(dá)式，適合技術(shù)與學(xué)術(shù)文檔。
• 無限頁面版本記錄：自動(dòng)保存每次修改，可隨時(shí)回溯歷史內(nèi)容。
• 支持附件上傳與下載：方便附加文檔、資料等文件資源。
• 支持圖片上傳（包括剪貼板粘貼）：可直接粘貼截圖或上傳圖片，圖文并茂更直觀。
• 支持命名空間分類內(nèi)容：通過命名空間組織頁面，結(jié)構(gòu)清晰易于管理。
• 自動(dòng)生成索引和站點(diǎn)地圖：自動(dòng)整理頁面結(jié)構(gòu)，便于導(dǎo)航與搜索引擎發(fā)現(xiàn)。
• 支持公開與私有瀏覽模式：可靈活控制頁面訪問權(quán)限，保護(hù)敏感信息。
• 語法高亮：代碼塊自動(dòng)高亮顯示，提升技術(shù)文檔可讀性。
• 多語言支持：適配多種語言界面，滿足國(guó)際化使用需求。
• 暗色模式：提供護(hù)眼暗色主題，適應(yīng)不同環(huán)境下的閱讀習(xí)慣。
• 站點(diǎn)地圖（Sitemap）：生成標(biāo)準(zhǔn) Sitemap 文件，有利于 SEO 優(yōu)化。
• 更多功能：持續(xù)更新，集成實(shí)用特性，滿足多樣化文檔需求。

二、本次實(shí)踐規(guī)劃

2.1 本地環(huán)境規(guī)劃

本次實(shí)踐為個(gè)人測(cè)試環(huán)境，操作系統(tǒng)版本為 Ubuntu 24.04.2 LTS。

2.2 本次實(shí)踐介紹

1.本次實(shí)踐部署環(huán)境為個(gè)人測(cè)試環(huán)境，生產(chǎn)環(huán)境請(qǐng)謹(jǐn)慎；

2.在Docker環(huán)境下部署WikiDocs文檔管理工具。

三、本地環(huán)境檢查

3.1 檢查Docker服務(wù)狀態(tài)

檢查Docker服務(wù)是否正常運(yùn)行，確保Docker正常運(yùn)行。

root@jeven:~# systemctl status docker
● docker.service - Docker Application Container Engine
     Loaded: loaded (/usr/lib/systemd/system/docker.service; enabled; preset: enabled)
     Active: active (running) since Mon 2025-08-04 10:10:52 UTC; 30min ago
TriggeredBy: ● docker.socket
       Docs: https://docs.docker.com
   Main PID: 860 (dockerd)
      Tasks: 10
     Memory: 97.2M (peak: 98.4M)
        CPU: 606ms
     CGroup: /system.slice/docker.service

3.2 檢查Docker版本

檢查Docker版本

root@jeven:~# docker -v
Docker version 28.3.3, build 980b856

3.3 檢查docker compose 版本

檢查Docker compose版本，確保2.0以上版本。

root@jeven:~# docker -v
Docker version 28.3.3, build 980b856

四、拉取WikiDocs鏡像

拉取WikiDocs容器鏡像，當(dāng)前最新版本為zavy86/wikidocs:1.

docker pull zavy86/wikidocs:1

五、部署WikiDocs服務(wù)

5.1 創(chuàng)建部署目錄

• 創(chuàng)建部署目錄

mkdir -p /data/wikidocs/data   &&  cd /data/wikidocs

• 目錄授權(quán)

chmod -R 755 /data/wikidocs/

5.2 編輯部署文件

在部署目錄下，創(chuàng)建docker-compose.yaml文件，內(nèi)容如下所示：

vim docker-compose.yaml

version: '3'

services:
  wikidocs:
    image: zavy86/wikidocs:1
    container_name: wikidocs
    restart: always
    ports:
      - 5200:80
    volumes:
      - /data/wikidocs/data:/datasets
    environment:
      - PUID=1000
      - PGID=1000

5.3 創(chuàng)建WikiDocs容器

執(zhí)行以下命令，創(chuàng)建WikiDocs容器。

docker compose up -d

5.4 查看WikiDocs容器狀態(tài)

檢查WikiDocs容器運(yùn)行狀態(tài)，確保WikiDocs容器正常啟動(dòng)。

root@jeven:/data/wikidocs# docker compose ps
WARN[0000] /data/wikidocs/docker-compose.yaml: the attribute `version` is obsolete, it will be ignored, please remove it to avoid potential confusion
NAME       IMAGE               COMMAND       SERVICE    CREATED          STATUS          PORTS
wikidocs   zavy86/wikidocs:1   "/start.sh"   wikidocs   28 seconds ago   Up 28 seconds   0.0.0.0:5200->80/tcp, [::]:5200->80/tcp

六、訪問WikiDocs服務(wù)

6.1 初始化安裝

瀏覽器地址： http://<個(gè)人的服務(wù)器IP>:5200，訪問WikiDocs的初始頁。如果無法訪問，請(qǐng)確保宿主機(jī)的防火墻已關(guān)閉或已放行相關(guān)端口，對(duì)于云服務(wù)器還需配置相應(yīng)的安全組規(guī)則。

環(huán)境檢查：系統(tǒng)將自動(dòng)檢測(cè)當(dāng)前安裝環(huán)境，當(dāng)所有檢測(cè)項(xiàng)均顯示為綠色對(duì)勾時(shí)，表示環(huán)境正常，可點(diǎn)擊“繼續(xù)”進(jìn)入下一步。

填寫相關(guān)配置信息，可參考如下：

• Owner：內(nèi)容的所有者
• - Notice：內(nèi)容版權(quán)聲明
• Edit authentication code：自定義填寫密碼
• Repeat edit authentication code：確認(rèn)密碼

確認(rèn)配置信息，點(diǎn)擊繼續(xù)下一步。

出現(xiàn)以下提示，則表示安裝完成。

6.2 訪問WikiDocs

點(diǎn)擊按照你完成界面的“continue”，則進(jìn)入到WikiDocs首頁。

七、WikiDocs基本使用

7.1 設(shè)置中文

在WikiDocs首頁，我們點(diǎn)擊右上角的“小鎖”圖標(biāo)。

輸入之前我們?cè)O(shè)置的訪問密碼后，如下所示：

點(diǎn)擊右上角的“齒輪”圖標(biāo)，進(jìn)入WikiDocs系統(tǒng)設(shè)置界面。

將系統(tǒng)語言設(shè)置為簡(jiǎn)體中文后，點(diǎn)擊“save”保存即可。

7.2 編輯文檔

點(diǎn)擊新增文檔選項(xiàng)，操作如下所示：

設(shè)置路徑：我們需要輸入新文檔路徑，例如參數(shù)/章節(jié)/標(biāo)題這種，如下所示：

編輯文檔后，點(diǎn)擊保存即可。

7.3 查看文章效果

文章保存后，可識(shí)別markdown語法，效果如下所示：

八、總結(jié)

本次實(shí)踐通過Docker成功部署了WikiDocs文檔管理工具，整個(gè)過程簡(jiǎn)潔高效，體現(xiàn)了容器化部署的優(yōu)勢(shì)。

WikiDocs基于Markdown的輕量設(shè)計(jì)和豐富的功能特性，非常適合用于個(gè)人或團(tuán)隊(duì)的知識(shí)管理。通過簡(jiǎn)單的目錄映射和配置，實(shí)現(xiàn)了數(shù)據(jù)的持久化與服務(wù)的穩(wěn)定運(yùn)行。未來可進(jìn)一步探索其權(quán)限管理、多用戶協(xié)作等高級(jí)功能，提升文檔管理效率。

以上為個(gè)人經(jīng)驗(yàn)，希望能給大家一個(gè)參考，也希望大家多多支持腳本之家。

最新評(píng)論