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 主题：

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 站点的预览服务器：

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

示例：

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

内容创作工具

创建新文章

使用以下命令在指定的 Hugo 站点中创建一篇新文章：

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

示例：

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

构建生产环境

使用以下命令构建用于生产环境的 Hugo 站点：

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

部署发布流程

部署站点到指定平台

使用以下命令将 Hugo 站点部署到指定的平台：

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 仓库 提交问题。