Markdown2pdf MCP

🚀 Markdown2PDF MCP 服務器（markdown2pdf-mcp）

Markdown2PDF MCP 服務器是一個能夠將 Markdown 文檔轉換為 PDF 文件的工具。它提供了簡單高效的方式，可從 Markdown 內容生成 PDF，支持語法高亮和自定義樣式，還能在第一頁添加水印。

🚀 快速開始

安裝

# 克隆倉庫
git clone https://github.com/2b3pro/markdown2pdf-mcp.git

# 進入項目目錄
cd markdown2pdf-mcp

# 安裝依賴
npm install

# 構建項目
npm run build

啟動服務器

npm start

使用 MCP 工具

該服務器提供了一個單一的工具create_pdf_from_markdown，具有以下參數：

{
  // 必填參數
  markdown: string;    // 要轉換為PDF的Markdown內容

  // 可選參數，默認值
  outputFilename?: string;  // PDF文件名（例如，“output.pdf”）
  paperFormat?: string;     // 'letter'（默認）、'a4'、'a3'、'a5'、'legal'、'tabloid'
  paperOrientation?: string; // 'portrait'（默認）或 'landscape'
  paperBorder?: string;     // '2cm'（默認），接受帶有CSS單位的十進制值（例如，“1.5cm”、“2.5mm”、“0.5in”、“10.5px”）
  watermark?: string;       // 可選水印文本（最多10個字符）
}

示例

// 啟動服務器
npm start

// 使用MCP工具的示例
{
  "command": "create_pdf_from_markdown",
  "params": {
    "markdown": "# 我的第一個PDF\n這是一個**Markdown**到PDF的轉換器。",
    "outputFilename": "example.pdf"
  }
}

✨ 主要特性

• 使用單個命令將 Markdown 轉換為 PDF
• 代碼塊的語法高亮
• PDF 輸出的自定義 CSS 樣式
• 支持標準 Markdown 格式
• 使用 Chrome 引擎生成現代 PDF
• 對現代網絡功能和字體有出色支持
• 可靠的資源加載和渲染

📦 安裝指南

# 克隆倉庫
git clone https://github.com/2b3pro/markdown2pdf-mcp.git

# 進入項目目錄
cd markdown2pdf-mcp

# 安裝依賴
npm install

# 構建項目
npm run build

💻 使用示例

基礎用法

// 啟動服務器
npm start

// 使用MCP工具的示例
{
  "command": "create_pdf_from_markdown",
  "params": {
    "markdown": "# 我的第一個PDF\n這是一個**Markdown**到PDF的轉換器。",
    "outputFilename": "example.pdf"
  }
}

高級用法

{
  "command": "create_pdf_from_markdown",
  "params": {
    "markdown": "# 我的第一個PDF\n這是一個**Markdown**到PDF的轉換器。",
    "outputFilename": "example.pdf",
    "paperFormat": "a4",
    "paperOrientation": "landscape",
    "paperBorder": "1.5cm",
    "watermark": "Confidential"
  }
}

📚 詳細文檔

配置輸出目錄

要更改默認的輸出目錄（./dist），可以在項目根目錄下創建一個.env文件，並添加以下內容：

OUTPUT_DIR=your_desired_directory

依賴項

Chrome版本

由於pdfmake依賴於Chrome Blink引擎，建議安裝最新版的Chrome瀏覽器。

開發指南

1. 安裝依賴：npm install
2. 啟動開發服務器：npm start

侷限性

以下 Markdown 元素不受支持：

• LaTeX 數學公式（例如，$x^2$ 或 $$\sum_{i=1}^n x_i$$）
• 複雜的數學公式或科學表示法

請僅使用以下受支持的 Markdown 元素：

• 標題（所有級別）
• 文本格式化（粗體、斜體、刪除線）
• 列表（有序和無序）
• 帶語法高亮的代碼塊
• 表格
• 引用塊
• 鏈接
• 圖片（本地文件和外部 URL）
• 任務列表

貢獻指南

1. Fork 倉庫
2. 創建功能分支（git checkout -b feature/amazing-feature）
3. 提交更改（git commit -m '添加一些神奇的功能'）
4. 推送到分支（git push origin feature/amazing-feature）
5. 打開 Pull Request

📄 許可證

MIT