mcpField
B
brandfy-guia-pdf

brandfy-guia-pdf

github.com/promovaweb文档处理13157 次安装2 周前更新
代码仓库

关于 brandfy-guia-pdf

用于将已批准的 Markdown 品牌指南编译为 PDF 的技能。它保留可编辑源文件和现有设计定制,并指导检查生成的文档。

主要功能

  1. 01将 Markdown 编译为 PDF
  2. 02安装本地设计资源
  3. 03保留现有定制内容
  4. 04检查链接、页面与媒体
  5. 05检查 PDF 版式和元数据

适用场景

  1. 01制作便于分享的品牌指南
  2. 02源文件变更后重新生成 PDF
  3. 03检查图片、表格和分页
  4. 04核对文档链接与元数据

安装

复制下面的命令,在终端中运行。

$npx skills add https://github.com/promovaweb/brandfy --skill brandfy-guia-pdf

安装后在 Claude Code 中输入/brandfy-guia-pdf确认已加载。

包含的文件

除 SKILL.md 外,安装时一起下载的参考资料和脚本。

agents/
openai.yaml
assets/
brand-guide.css
assets/pdf-design-system/
pdf.css
README.md
template.html
assets/pdf-design-system/fonts/
OFL-Inter.txt
OFL-Manrope.txt
references/
pdf-build.md
scripts/
build-brand-guide.mjs

详细介绍

将品牌指南编译为 PDF

操作流程

  • **计划与进度:**规划源文件、主题、编译和检查。
  • **真实依据:**阅读 BRAND.md、作为索引的 brand/README.md、链接的资源以及 pdf-build.md。
  • **范围与幂等性:**将设计系统复制到 brand/pdf/ 并生成 PDF,不修改可编辑源文件,也不覆盖自定义内容。
  • **验证:**重新编译,检查链接、页面、图像、字体、目录和 元数据。
  • **最终摘要:**说明源文件、PDF、所用工具和警告。

流程

  1. 确认 BRAND.md 是已批准的版本,并且相对链接 均存在。

  2. 安装或检查本地资源:

    node <caminho-da-skill>/scripts/build-brand-guide.mjs \
      --project . \
      --install-assets
    

    该命令会将 CSS、模板、Inter、Manrope 和许可证复制到 brand/pdf/。 现有文件会保留。只有在检查已安装版本的差异后,才使用 --force-assets。

  3. 编译:

    node <caminho-da-skill>/scripts/build-brand-guide.mjs \
      --project . \
      --input BRAND.md \
      --output brand/brand-guide.pdf \
      --brand-name "Nome da marca"
    
  4. 编译器使用 Pandoc 生成语义化 HTML,并使用 WeasyPrint 生成 PDF。如果初次检查发现缺少这些工具,请安装。

  5. 保持 pdf-design-system: 1.0.0 规范:A4、浅色封面、Manrope、 Inter、目录、编辑组件和分页。名称、Logo、描述、标语和链接颜色均可自定义,无需重复主题。

  6. 打开 PDF,检查封面、目录、分页、表格、SVG、PNG、URL、 页眉、页脚和文档属性。

  7. 每当 Markdown、CSS、字体或链接资源发生变化时,都要重新编译。

如果图像、表格或文本在 PDF 中显示异常,请修正 brand/README.md、CSS 或链接资源。重新编译并打开受影响的页面,以确认修正效果,不要直接编辑 PDF。

专家思路

将 PDF 视为规范源文件的呈现形式,而不是独立文档。评估可读性、导航、教学顺序、 复现能力、可访问性和资源可追溯性。即使编译没有技术错误,如果隐藏了示例、将规则与上下文分开,或使表格难以阅读,编译结果仍然不合格。

评论

支持 Markdown