学术Pandoc模板指南

最新推荐文章于 2024-12-25 09:50:28 发布

倪焰尤Quenna

最新推荐文章于 2024-12-25 09:50:28 发布

阅读量1.1k

点赞数 12

CC 4.0 BY-SA版权

本文链接：https://blog.youkuaiyun.com/gitblog_00190/article/details/142542615

学术Pandoc模板指南

academic-pandoc-template Write beautifully typeset academic texts with distraction-free Markdown and Pandoc. 项目地址: https://gitcode.com/gh_mirrors/ac/academic-pandoc-template

本指南旨在帮助您理解和使用[学术Pandoc模板](https://github.com/maehr/academic-pandoc-template.git)，这是一个强大的工具，允许您以Markdown格式无干扰地撰写美观的学术文本，包括文章、演讲稿和论文。

1. 项目目录结构及介绍

该仓库遵循一个组织良好的结构，确保学术写作过程清晰高效。以下是关键目录及其用途概览：

article: 包含示例文章的Markdown源文件(article.md)以及其对应的参考文献(references.bib)。
presentation: 演讲稿相关的Markdown和BibTeX文件，用于构建演示文稿。
thesis: 论文部分，通常包括多个Markdown文档，结构化处理学位论文的不同章节。
default.yaml: 默认配置文件，控制文档的基本构建选项。
<doc_type>/yaml: 针对不同输出格式（如PDF、HTML）的特定配置文件，位于相应的子目录下。
Makefile: 提供了构建所有或指定类型的文档的命令规则。
.gitattributes, .gitignore, LICENSE, README.md 等标准Git和项目管理文件。
security.md, CONTRIBUTING.md, CODE_OF_CONDUCT.md: 项目安全指导、贡献指南和行为准则。

2. 项目的启动文件介绍

主要的启动点是Markdown源文件。在每个子目录中（如article/article.md, presentation/presentation.md），这些文件是你开始输入学术内容的地方。使用Markdown语法结合特定的元数据块（YAML前端块），你可以定义作者信息、日期、关键词等，并且通过引用外部的BibTeX文件来管理你的引用。

例如，在文章目录下的article.md，你可能会看到类似这样的开头，定义了基本的文档元数据：

---
author: 
  - 'Eleanor Roosevelt <eleanor.roosevelt@domain.com>'
  - 'John Peters Humphrey <jph@domain.com>'
bibliography: references.bib
csl: https://www.zotero.org/styles/chicago-note-bibliography
date: 1 January 2023
...
---

3. 项目的配置文件介绍

default.yaml: 这份文件设定了构建文档的基础设置，比如默认的样式和输出格式偏好。
特定格式配置文件（例如article/pdf.yaml, presentation/html.yaml）: 允许你针对不同的输出格式（PDF, HTML, etc.）微调编译选项，包括字体、样式等。
.prettierrc: 可选的代码格式化配置，用于保持Markdown代码的一致性。
package.json: 如果你使用Node.js工具链进行额外的自动化操作，这里面定义了脚本和依赖项。