Yiyang Sun

Love for life and frontend tech.

GitHubPostsLinksResume

试试用 Markdown 写报告文档

众所周知,写文档是工程师必备技能之一,而在某些学校的某些专业,对这一能力的要求和锻炼更是高一个层次。

为提升文档编造体验做过的努力

上大学后,我遭遇了很多需要写「报告」的课程或项目。使用图文的形式将自己的学习、编码成果展现出来,并进行存档,方便回看、传承或上面检查,这本无可非议。最令人难受的是我尝试了一些工具,却没有找到一个趁手的。

各种云文档产品

不爽的点:

  • 导出后调段落格式;
  • 导出后部分格式混乱或丢失(如导出后公式丢失、有序列表编号混乱等);
  • 刚调整好格式,又发现一些错误,需要重新导出或者同一个错误改两遍;
  • 在 Word 里添加页眉页码;

直接使用 Word

虽然 Word 具备导入导出段落格式配置的功能,但 10+ 页的报告需要手动调整大纲级别,单独配置页码,设置分页和分 Section,奇偶页页眉……

此外,还需要针对普通段落中的「普通英文」和 行内代码 样式进行单独设置,Word 的公式输入体验一言难尽等,都是劝退我这个 Office 老用户的原因。

关于 md-report

写这个工具的想法开始于《企业实习初期报告》 DDL 前几天,参考 slidev,既然有可能用 Markdown 写屁屁踢,那也有可能用 Markdown 写 Word。

md 可以是你想到的任何缩写。

md-report 的目标是让用户能够专注于报告的内容,改善报告编写体验,降低报告编造成本,提升效率。

Feature List

自卖自夸。

  • 支持自动生成页眉、页码;
  • 支持自动生成目录;
  • 最多支持 6 级标题;
  • 支持行内代码和代码块(目前西文使用 Monaco 字体,中文使用 楷体);
  • 支持公式块;
  • 支持本地图片;
  • 支持表格;
  • 支持无序/有序列表;

使用说明书

请参考 GitHub README

如需绘制 UML,推荐使用 Draw.io

Future Feature

  • 样式支持定制;
  • 支持行内公式;
  • ……

使用问题及改进建议

Issue or PR welcome!

cd ../