-
Notifications
You must be signed in to change notification settings - Fork 318
Home
本项目是一个 markdown 主题,目标是轻松地让您将用 markdown 撰写的报告与论文用看起来像 LaTeX 风格的样式导出。需要说明的是,预设的风格基本采用了浙江大学要求的格式(字体较小,页边距较小),但您可以自行在 CSS 中修改适合自己学校的格式。
以下内容仅仅是一些精简的描述。如果您想了解更多细节,请您点击相关的超链接。
参见:安装教程
-
安装本主题前,请确保您已经安装 Typora. 如果您不清楚 Typora 是什么,这里有一段介绍。如果您对 markdown 的语法还不了解,您可以从这里获得帮助。
-
前往本项目的 release 页面,然后下载适合您操作系统的最新版本压缩包。比如,如果您在使用 Windows 操作系统,您就应该下载
latex-theme-windows.zip
. -
解压缩这个文件,并进入解压缩后的文件夹。在这个文件夹中,用 Typora 打开
README.md
,并按照其中的描述完成剩余步骤。简单而言,需要进行如下几步:- 进行手动或自动主题安装
- 若遇到字体问题,则下载所需的字体
参见:个性化设置
在完成安装后,您可以选择按照学校的要求或自己的喜好,对主题个性化设置。在 CSS 文件中,您可以根据代码中的注释提示修改变量取值,轻松地更换正文、标题等不同元素的字体、字号、行距、页边距等。您也可以考虑使用我们提供的封面模板,或者手动取消额外行距。
很抱歉,目前我们没有为主题提供热更新机制。如果您已经对主题文件进行过个性化设置,在更新主题时,您可能需要:
- 备份原本的 CSS 文件(例如,将
latex.css
重命名为latex-old.css
); - 安装新的主题文件;
- 参照您原先所做的个性化设置重新设置一遍新的主题文件。
不过,您可能已经注意到,我们已经将主要的个性化设置的变量放置在
@charset "UTF-8";
:root {
/* == 字体设置 == */
/* 基准字体 */
/* 超链接颜色 */
……(其他设置)
……(其他设置)
--link-color-dark: #8bb1f9;
}
主题文件的最前面。因此,对大部分普通用户来说,您只需要关注最前面(约前70行)代码中您做过的改动即可。
参见:贡献指南
如果您在使用过程中遇到任何问题,或想为本项目做出任何贡献,请优先考虑:
- 前往 GitHub Discussions 发起讨论
- 前往 GitHub Issues 报告故障
- 前往 GitHub Issues 请求新功能
- 如果您希望在本地修改这个项目的代码,推荐您在 fork 后使用
git clone ${target} --depth 1
进行克隆。这是因为,本仓库的历史中有大量二进制文件,而这些二进制文件对当前开发并无作用,可以舍弃。设置较浅的克隆深度可帮助您更快地获取到此项目的最新代码。在完成您的修改后,请向我们的develop
分支提出拉取请求。
如果以上方法都行不通,您也可以考虑: