HubSpot 上的技术文档写作

» 变更日志 | PyPI | 问题 | 源代码 | 许可

关于

• 支持在 HubSpot 上编写技术文档。
• Markdown 到 HTML 转换器，具有创建 HubSpot 博客文章的相关功能。
• 使用 hubspot-api-python 包将博客文章和文件上传到 HubSpot API。
• 查看关于 “技术博客作者的 Markdown 支持” 的社区请求。

设置

pip install --upgrade hubspot-tech-writing

安装后，您可以验证是否成功。

hstw --version

用法

标记转换

您可以将您工作站上的 Markdown 文件转换为 HTML 文件。

wget -O original.md https://github.com/crate-workbench/hubspot-tech-writing/raw/main/tests/data/hubspot-blog-post-original.md
hstw convert original.md converted.html

或者，将远程位置的 Markdown 文件转换为 HTML，并将其输出写入 STDOUT。

hstw convert https://github.com/crate-workbench/hubspot-tech-writing/raw/main/tests/data/hubspot-blog-post-original.md

链接检查器

为了报告关于网页中缺少链接或内联图片，请在您的 Markdown 文档上运行链接检查器。

hstw linkcheck original.md

或者，您也可以在这里使用远程资源。

hstw linkcheck https://github.com/crate-workbench/hubspot-tech-writing/raw/main/tests/data/hubspot-blog-post-original.md

HubSpot 上传

上传到 HubSpot 是一个迭代过程，所以您可能需要在同一资源上多次使用程序。为了简化调用，我们建议定义一个环境变量来存储您的 HubSpot API 访问令牌。

export HUBSPOT_ACCESS_TOKEN=pat-na1-e8805e92-b7fd-5c9b-adc8-2299569f56c2

从工作站上传 HTML 文件。博客文章的名称将来自文件名。

hstw upload testdrive.html

从工作站上传 PNG 图片到 hubfs 上的文件夹路径。

hstw upload testdrive.png --folder-path=/foo/bar

将 Markdown 转换为 HTML，使用不同的名称上传文档，并上传所有引用的图片。

hstw upload /path/to/document.md --name=a-different-name --folder-path=/blog/2023/topic

有关此功能的更详细信息，请参阅内联帮助

hstw upload --help

HubSpot 删除

您可以通过其唯一的资源标识符或名称/路径来删除博客文章和文件实体。

# Delete blog post by resource identifier.
hstw delete post --id=138458225506

# Delete file by path.
hstw delete file --path=/testdrive/foo.png

有关此功能的更详细信息，请参阅内联帮助

hstw delete --help

故障排除

博客文章可能不包含嵌入式图片

如果您直接从 GitHub 上传，并运行这样的命令，

hstw upload https://github.com/acme/foo-repo/raw/main/article.md --name=testdrive

只收到这样的错误消息，

{
  "correlationId": "4836e94d-e42b-47a1-afff-597d8b67ba93",
  "errorType": "BLOG_POST_CONTAINS_EMBEDDED_IMAGES",
  "message": "Blog posts may not contain embedded images. Please upload images to File Manager.",
  "status": "error"
}

您很可能在使用一个“私有”仓库，其中 hstw 没有访问权限。

现有技术

• https://github.com/verypossible/hubmd
• https://github.com/danjamescrosby/markdown-to-hubspot-blog