Skip to content

主要功能 ​

Scholarly 在 Slidev 的基础上加入学术演示常用的布局、组件、BibTeX 引用、主题预设和编辑器工具。

学术演示结构 ​

  • 34 种布局,覆盖封面、章节、正文、图片、对比、方法、结果、时间线、附录、答辩和参考文献页。
  • 自动处理页眉和页脚,支持作者、会议信息、页码和可选的 Beamer 风格导航。
  • 较长的演示可以从页脚打开大纲,并按 layout: section 分组。

如果已经知道下一页要表达什么,先从布局开始。

研究组件 ​

定理、指标和证据等重复内容由组件统一排版:

组件类型组件
陈述Theorem、Block、Highlight、Keywords
结构Steps、Columns
证据MetricCard、MetricGrid、EvidenceBlock、EquationBlock、ResultTable
论文上下文DatasetCard、PaperCard、ContributionList、CaveatList
引用Cite、参考文献布局、注脚预览

定理类陈述支持中文和英文标签、自动编号、手动编号和自定义编号格式。

引用和注脚 ​

  • 使用 @citekey 写括号引用。
  • 使用 !@citekey 写叙述性引用。
  • 使用标准 Markdown 注脚,并继承 Scholarly 的显示样式。
  • 桌面端悬停注脚标记可预览内容,点击可固定浮窗。
  • 从 BibTeX 生成 APA、Harvard、Vancouver、IEEE、MLA 或 Chicago 样式参考文献。

大多数演示只需在 frontmatter 中设置 bibFile 和 bibStyle。

数据驱动结果页 ​

可以将 JSON 或 CSV 导入 ResultTable 和 MetricGrid,按需使用主题提供的数据辅助函数,无需添加图表依赖。一页只有几个数值时,直接写 Markdown 表格通常更简单。

从数据生成幻灯片提供完整示例,并说明数据文件和导入语句应该放在哪里。

从 BibTeX 生成论文摘要 ​

从 BibTeX key 生成论文摘要:

bash
pnpm exec sch paper summary --bib references.bib --key sample2026

命令会读取标题、作者、年份、DOI、URL 和会议等字段,并生成一张 paper-summary 幻灯片。使用 --layout paper-card 可以改为生成组件片段,使用 --json 则会输出便于脚本处理的结构化数据。缺失字段会写入 warnings;即使关键信息不全,命令仍会生成可继续编辑的 Markdown。

主题预设 ​

内置配色包括经典蓝、牛津酒红、剑桥绿、耶鲁蓝、普林斯顿橙、北欧蓝、暖棕、单色和高对比度。

先在色彩与字体主题中选择配色和字体,再到主题模式与对比度设置明暗模式并检查可读性。

写作工具 ​

  • CLI 模板创建完整项目,工作流则向 Markdown 文件追加一组片段。
  • pnpm exec sch doctor 会报告配置问题并给出可执行修复建议。
  • VS Code 代码片段可插入布局和组件。
  • VS Code 预览与文档站使用同一批生成截图。

编辑器设置见 VS Code 插件。

离线使用 ​

BibTeX 引用、手动注记、参考文献页和本地数据导入不依赖远程服务。离线演示前,需先安装依赖,并准备所用字体、图片等远程资源。请断开网络后完整预览一次。