《Mark 项目安装与配置指南》

《Mark 项目安装与配置指南》

mark Sync your markdown files with Confluence pages. 项目地址: https://gitcode.com/gh_mirrors/ma/mark

1. 项目基础介绍

Mark 是一个开源工具，用于将 Markdown 文档同步到 Atlassian Confluence 页面。它特别适合那些将文档存储在 Git 仓库中，但又不想手动更新 Confluence 页面内容的使用场景。Mark 通过读取 Markdown 文件，创建或更新 Confluence 页面，上传附件，将 Markdown 转换为 HTML，并通过 REST API 更新页面内容。

该项目主要使用 Go 语言编写。

2. 项目使用的关键技术和框架

• Go 语言：项目的主体语言，用于实现命令行工具和 HTTP API 交互。
• Markdown 解析：将 Markdown 格式的文档转换为 HTML，以便在 Confluence 上显示。
• REST API：与 Confluence 的交互通过 REST API 完成，实现自动化的文档同步。
• 模板引擎：支持 Go 模板，允许自定义页面的布局和样式。

3. 项目安装和配置的准备工作及详细步骤

准备工作

• 确保您的系统中已安装 Go 语言环境。
• 安装 Git 用于克隆和更新项目代码。
• 确保您有 Confluence 的访问权限和必要的 API 认证信息。

安装步骤

1. 克隆项目到本地：

   git clone https://github.com/kovetskiy/mark.git
   

2. 进入项目目录：

   cd mark
   

3. 安装项目依赖：

   go mod tidy
   

4. 编译项目（如果您需要编译为可执行文件）：

   go build -o mark .
   

   这将在当前目录下生成一个名为 mark 的可执行文件。

5. 配置 Mark（在项目目录中创建一个配置文件，例如 config.yaml）：

   space_key: "YOUR_SPACE_KEY"
   parent_page: "Parent Page Title"
   page_title: "Page Title"
   confluence_url: "https://your-confluence-url.atlassian.net"
   username: "YOUR_CONFLUENCE_USERNAME"
   password: "YOUR_CONFLUENCE_PASSWORD"
   

   替换上述配置中的占位符为您的 Confluence 空间键、父页面标题、页面标题、Confluence URL、用户名和密码。

6. 使用 Mark 同步 Markdown 到 Confluence：

   ./mark -c config.yaml -f path/to/your/markdown/file.md
   

   替换 path/to/your/markdown/file.md 为您的 Markdown 文件路径。

按照上述步骤操作，您应该能够成功安装和配置 Mark，并开始同步您的 Markdown 文档到 Confluence 页面。

mark Sync your markdown files with Confluence pages. 项目地址: https://gitcode.com/gh_mirrors/ma/mark