Hugo MCP

🚀 Hugo 站點配置流程文檔

本項目提供了一系列工具，用於簡化 Hugo 站點的安裝、配置、主題管理、內容創作、部署等操作，幫助用戶更高效地搭建和管理自己的 Hugo 站點。

🚀 快速開始

安裝檢查工具

檢查 Hugo 安裝狀態

使用以下命令檢查 Hugo 的安裝狀態：

hugo-mcp check-hugo

輸出示例：

{
  "status": "success",
  "version": "0.98.6"
}

若未安裝，系統將自動下載並安裝最新版本的 Hugo。

檢查 Git 安裝狀態

使用以下命令檢查 Git 的安裝狀態：

hugo-mcp check-git

輸出示例：

{
  "status": "success",
  "version": "2.34.1"
}

若未安裝，系統將自動下載並安裝最新版本的 Git。

📦 安裝指南

本項目的工具在檢查安裝狀態時，若檢測到未安裝相應軟件，會自動進行下載和安裝，無需額外操作。

💻 使用示例

站點創建與配置

創建新站點

使用以下命令創建新的 Hugo 站點：

hugo-mcp create-site [site-name] --theme=[theme-url] [--use-example-site]

示例：

hugo-mcp create-site my-blog --theme=https://github.com/nanxiaobei/hugo-paper --use-example-site

配置 Git 信息

使用以下命令配置 Git 信息：

hugo-mcp config-git [name] [email]

示例：

hugo-mcp config-git "John Doe" john.doe@example.com

主題管理

列出可用主題

使用以下命令列出可用的主題：

hugo-mcp list-themes

輸出示例：

{
  "themes": [
    {
      "name": "Paper",
      "url": "https://github.com/nanxiaobei/hugo-paper"
    },
    {
      "name": "Default",
      "url": "https://github.com/gohugoio/hugo-default-theme"
    }
  ]
}

獲取主題詳情

使用以下命令獲取指定主題的詳情：

hugo-mcp get-theme-details [theme-name]

示例：

hugo-mcp get-theme-details Paper

站點管理操作

啟動預覽服務器

使用以下命令啟動預覽服務器：

hugo-mcp start-preview [site-path] [--port=8080]

示例：

hugo-mcp start-preview /path/to/my/blog --port 9000

內容創作工具

創建新文章

使用以下命令創建新的文章：

hugo-mcp create-post [site-path] [post-title] [--draft]

示例：

hugo-mcp create-post /path/to/my/blog my-first-post --draft

構建生產環境

使用以下命令構建生產環境：

hugo-mcp build-site [site-path] [--minify]

部署發佈流程

部署站點到指定平臺

使用以下命令將站點部署到指定平臺：

hugo-mcp deploy-site [site-path] --platform=[platform] [--branch=main] [--commit-message="Update site"] [--api-key=your-token] [--remote-url=https://example.com]

支持的平臺：

• GitHub Pages
• Netlify
• Vercel
• Custom Git 倉庫

示例：

hugo-mcp deploy-site /path/to/my/blog --platform github-pages --branch gh-pages --commit-message "Deploy site" --api-key your-github-token

📚 詳細文檔

故障排查

常見問題

1. Hugo 未安裝：
   使用 hugo-mcp install-hugo 工具進行安裝。
2. Git 未安裝：
   使用 hugo-mcp install-git 工具進行安裝。
3. 主題安裝失敗：
   • 檢查主題 URL 是否正確。
   • 確保 Git 和 Go 安裝正常，以便處理子模塊和依賴。
4. 預覽服務器啟動失敗：
   • 檢查端口是否已被佔用。
   • 確認站點路徑無誤。
5. 構建失敗：
   • 確認站點路徑正確。
   • 確保所有依賴項已安裝。

獲取幫助

如遇未列出的問題，請訪問 GitHub 倉庫 提交問題。