跳至主要内容

TailorMed 文檔網站 - 客戶使用指南

給客戶的簡單說明 - 如何在您的電腦上查看文檔網站

🚀 快速開始（最簡單的方法）​

兩種使用模式​

模式 1：預覽模式（推薦，搜尋功能可用）⭐​

Windows 用戶：

  • 雙擊 開啟文件管理系統-預覽模式.bat

Mac 用戶：

  • 執行 開啟文件管理系統-預覽模式.sh

特點：

  • ✅ 搜尋功能完全可用
  • ✅ 使用建置後的完整版本
  • ⚠️ 編輯文檔後需要重新執行批次檔才能看到更新

模式 2：開發模式（即時預覽，但搜尋不可用）​

Windows 用戶：

  • 雙擊 開啟文件管理系統.bat

Mac 用戶：

  • 執行 開啟文件管理系統.sh

特點：

  • ✅ 編輯文檔後立即看到更新（無需重新執行）
  • ✅ 啟動速度快
  • ❌ 搜尋功能無法使用（這是技術限制）

第一次使用（預覽模式）：​

  1. 找到檔案：
    • Windows：在 tm-docs 資料夾中找到 開啟文件管理系統-預覽模式.bat
    • Mac：在 tm-docs 資料夾中找到 開啟文件管理系統-預覽模式.sh
  2. 執行檔案：雙擊對應的檔案
  3. 等待建置：會自動建置網站（約 1-2 分鐘）
  4. 等待開啟：建置完成後，瀏覽器會自動開啟文檔網站
  5. 查看文檔：現在可以瀏覽所有文檔內容，搜尋功能可用

之後使用：​

  • 預覽模式：直接執行 開啟文件管理系統-預覽模式.bat（會自動重新建置並開啟）
  • 開發模式：直接執行 開啟文件管理系統.bat（快速啟動，但搜尋不可用）

💡 重要提示：

  • 預覽模式：每次執行都會重新建置，確保包含所有最新變更和搜尋索引
  • 開發模式：啟動快速，但搜尋功能無法使用
  • 關閉終端機視窗會停止伺服器
  • 如果顯示的端口不是 3000，請使用終端機中顯示的實際網址

方法 1：使用批次檔/腳本（推薦）​

第一次使用：​

  1. 找到檔案：在 tm-docs 資料夾中找到 開啟文件管理系統.bat
  2. 雙擊執行：雙擊 開啟文件管理系統.bat 檔案
  3. 等待建置：會自動建置網站（約 1-2 分鐘）
  4. 等待開啟：建置完成後，瀏覽器會自動開啟文檔網站
  5. 查看文檔：現在可以瀏覽所有文檔內容

之後使用：​

  • 只是查看：直接雙擊 開啟文件管理系統.bat 即可（會自動重新建置並開啟）
  • 編輯文檔後：編輯完文檔後，重新執行 開啟文件管理系統.bat 才能看到最新變更

💡 重要提示：

  • 每次執行都會重新建置，確保包含所有最新變更
  • 關閉命令視窗會停止伺服器
  • 如果顯示的端口不是 3000，請使用命令視窗中顯示的實際網址
  • 例如：如果顯示 http://localhost:3001，請使用這個網址

📁 方法 2：直接打開建置後的檔案​

步驟：​

  1. 建置網站（只需要做一次）：

    • 在 tm-docs 資料夾中，按住 Shift 鍵並右鍵點擊空白處
    • 選擇「在此處開啟 PowerShell 視窗」或「在此處開啟終端機」
    • 輸入：npm run build
    • 等待建置完成（約 1-2 分鐘）

  2. 打開網站：

    • 建置完成後，進入 build 資料夾
    • 找到 index.html 檔案
    • 雙擊打開即可

⚠️ 注意：直接打開 HTML 檔案時，部分功能（如頁面跳轉）可能無法正常運作。建議使用方法 1。

🖥️ 方法 3：使用簡單的本地伺服器​

如果您的電腦有 Python：​

  1. 建置網站：npm run build
  2. 進入 build 資料夾
  3. 在資料夾中開啟終端機，輸入： 
    python -m http.server 8000
  4. 在瀏覽器開啟：http://localhost:8000

如果您的電腦有 Node.js：​

  1. 建置網站：npm run build
  2. 執行：npm run serve
  3. 在瀏覽器開啟顯示的網址

📝 編輯文檔​

如何編輯文檔內容：​

  1. 找到文檔檔案：

    • 進入 docs 資料夾
    • 找到要編輯的 .md 檔案

  2. 編輯檔案：

    • 用記事本、VS Code 或其他文字編輯器打開
    • 修改內容
    • 儲存檔案

  3. 查看更新（重要！）：

    • 必須重新執行 開啟文件管理系統.bat
    • 批次檔會自動重新建置並開啟最新版本
    • 然後在瀏覽器中查看更新（可能需要按 F5 重新整理）

⚠️ 重要：編輯文檔後，必須重新執行批次檔才能看到變更！

❓ 常見問題​

Q: Windows - 雙擊 開啟文件管理系統.bat 沒有反應？​

A: 請確認：

  1. 已經執行過 npm install（只需要做一次）
  2. 在正確的資料夾中（tm-docs 資料夾）

Q: Mac - 無法執行 開啟文檔.sh？​

A: 請在終端機中執行：

cd tm-docs
chmod +x 開啟文件管理系統.sh
./開啟文件管理系統.sh

或者右鍵點擊檔案 → 選擇「打開方式」→ 選擇「終端機」

A: 請確認：

  1. 已經執行過 npm install（只需要做一次）
  2. 在正確的資料夾中（tm-docs 資料夾）

Q: 如何停止伺服器？​

A: 關閉命令視窗（黑色視窗）即可

Q: 可以離線使用嗎？​

A: 可以！建置後的檔案完全可以在離線狀態下使用

Q: 需要網路連線嗎？​

A:

  • 建置時：需要（下載套件）
  • 使用時：不需要（完全離線可用）

📂 檔案結構說明​

tm-docs/
├── docs/              ← 文檔內容（在這裡編輯）
├── build/             ← 建置後的檔案（建置後才會出現）
├── 開啟文件管理系統.bat       ← 雙擊這個檔案來開啟網站
└── package.json       ← 專案設定檔

💡 小技巧​

  • 快速編輯：直接編輯 docs/ 資料夾中的 .md 檔案
  • 即時預覽：使用 開啟文件管理系統.bat 可以即時看到變更
  • 備份重要：編輯前建議先複製一份備份

需要幫助？ 隨時聯絡技術支援！