mcpField
E
elegant-reports

elegant-reports

github.com/jdrhyne文档处理240256 次安装9 周前更新
代码仓库

关于 elegant-reports

elegant-reports 是一项将 Markdown 转为北欧编辑风格 PDF 报告的技能,适合制作简报、分析报告和演示式文档,并提供可复用模板与主题。

主要功能

  1. 01将 Markdown 生成为 PDF
  2. 02简报、报告和演示模板
  3. 03支持的模板提供明暗主题
  4. 04通过 YAML 配置输出
  5. 05生成 HTML 以检查布局

适用场景

  1. 01制作高管简报或董事会报告
  2. 02将 Markdown 分析内容转为 PDF
  3. 03生成每页呈现一个主题的演示文档

安装

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

$npx skills add https://github.com/jdrhyne/agent-skills --skill elegant-reports

安装后在 Claude Code 中输入/elegant-reports确认已加载。

包含的文件

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

.gitignore
generate.js
NORDIC_DESIGN_RESEARCH.md
package-lock.json
package.json
examples/
sample-executive.md
sample-output.html
references/
nordic-design-research.md
scripts/
smoke-test.js
templates/
analysis.html
executive-v2.html
executive.html
metrics.html
notes.html
presentation-dynamic.html
report-dynamic.html
report-v2.html
themes/
nordic-dark.css
nordic-light.css
nordic-report-dark.css
nordic-report.css
nordic-v2.css

详细介绍

elegant-reports

生成受斯堪的纳维亚编辑设计启发的极简 PDF 报告。

适用场景

在用户需要以下内容时使用此技能:

  • 精致的高管简报或董事会风格报告
  • 由 Markdown 生成的演示文稿风格 PDF
  • 简洁的北欧视觉风格,而非默认的开发者样式
  • 可谨慎扩展的可复用报告模板系统

快速开始

从 package-lock.json 安装固定版本的依赖项,然后运行:

cd /path/to/elegant-reports
node ./generate.js --list
node ./generate.js examples/sample-executive.md output.pdf --template executive --theme light

如需调试 HTML,添加 --output-html,生成器会在 PDF 旁保存渲染后的 HTML。

可用模板

模板适用场景
executive精致的简报和精简的高管摘要
report内容更密集的叙述性报告和分析文档
presentation醒目的幻灯片风格输出,每页呈现一个观点
report-demo用于对比和测试的旧版报告变体
presentation-demo用于对比和测试的旧版演示文稿变体

每个模板都支持 light 和 dark 主题(若适用)。

Frontmatter

添加 YAML frontmatter 以控制渲染后的输出:

---
title: Q4 Competitive Analysis
subtitle: Market Intelligence Report
author: Report Author
template: report
theme: dark
---

Your content here...

工作流

  1. 选择最接近需求的现有模板,而不是从头开始。
  2. 编写或润色源 Markdown。
  3. 生成 PDF。
  4. 如果需要调整布局,使用 --output-html 检查生成的 HTML,并调整对应的模板/主题组合。
  5. 反复运行,直到设计简洁、PDF 稳定。

扩展此技能

编写新的视觉变体时:

  • 从最接近的内置模板和主题开始
  • 保持令牌名称和间距比例与现有系统一致
  • 每次只做一项视觉更改,并在每一步后重新生成
  • 优先采用增量式变体,而不是重写整个设计语言
  • 在替代模板通过验证前,保留旧版/演示模板

内置的北欧设计研究笔记是该视觉系统的权威参考。只有在需要深入了解设计原理时才阅读。

安全边界

  • 除非用户明确要求通过 Nutrient DWS 生成 PDF 并接受相应的网络边界,否则不要将敏感源文档发送给第三方服务。
  • 不要浏览任意本地文件。读取范围仅限于技能包和用户批准的输入/输出路径。
  • 不要覆盖或删除用户批准的工作目录之外的文件。
  • 除非用户明确要求进行相关设置,否则不要安装额外软件包、更改依赖项版本或添加新的外部服务。
  • 除非输出文件确实存在且生成器已无错误地完成运行,否则不要声称报告已成功生成。
  • 除非用户明确要求进行最新的视觉研究,否则不要获取外部设计灵感或网页参考资料。

依赖项

  • Node.js 18+
  • package-lock.json 中固定版本的 npm 依赖项
  • 用于生成 PDF 的 NUTRIENT_DWS_API_KEY 环境变量

文件结构

  • 主生成器 CLI 和模块入口点
  • 内置 HTML 模板
  • 内置视觉主题
  • 示例 Markdown 输入
  • 随技能提供的可选深入设计原理说明

验证

在确认技能已完成之前:

  • 运行 node ./generate.js --list
  • 运行 npm test
  • 确认请求的输出路径中存在预期的 PDF 或 HTML 文件

评论

支持 Markdown