本项目的初衷是为了简化中国大陆本科生小型通识课论文(或实小型验报告)撰写的负担。这里基本采用了浙江大学要求的格式(字体较小,页边距较小),但大部分同学都可以自行在 CSS 中修改适合自己学校的格式。
markdown 的轻量化特性,使您可以专注于论文内容而不用担心格式。书写时仅通过简单的标记,并通过替换样例模板中的个人信息,您就可以输出媲美卷王由LaTeX排版的精美论文与报告。
这是一个 Typora 的 markdown 主题样式,该主题理论上适用于所有平台,CSS 也适用于部分其他编辑器。macOS 和 Windows 中的个别特性可能不同。
If you are not studying in China, please DO NOT use this theme. Intead, you could check another theme: Paper – A typora theme using latex fonts to be used in academic work.
(较完整的论文预览见这里: 点我😀;如果GitHub中的图像加载不出来,您也可以查看我博客上的说明。)
层级标题:
### 标题3
#### 标题4
##### 标题5
###### 标题6
表格:
<center><strong>表 2 全球/中国桌面操作系统市场份额占比(%)</strong></center>
| OS | Windows | macOS | Unknown | Linux | Chrome OS | 其他 |
| ---- | ------- | ----- | ------- | ----- | --------- | ---- |
| 全球 | 76.56 | 17.1 | 2.68 | 1.93 | 1.72 | 0.01 |
| 中国 | 87.55 | 5.44 | 6.24 | 0.75 | 0.01 | 0.01 |
项目列表:
1. 有序列表项
2. 有序列表项2
+ 无序列表项1
+ 无序列表项2.
* [x] 表示已完成。 ***==(请尽量不要使用此功能,因为它的对齐效果不佳,以后可能考虑修改)==***
* [ ] 表示未完成。
* 项目1
* 项目2
* 项目3
1. 项目1
2. 项目2
1. 项目2.1
2. 项目2.2
1. 项目2.2.1
2. 项目2.2.2
代码块
```html
<!DOCTYPE html>
<html>
<body>
<h1>The *= Operator</h1>
<p id="demo"></p>
<script>
var x = 10;
x *= 5;
document.getElementById("demo").innerHTML = x;
</script>
</body>
</html>
```
mermaid 图形
```mermaid
graph LR
A(开始) -->
input[/输入a,b/] --> if{a%b=0 ?}
if --->|yes| f1[GCD = b] --> B(结束)
if --->|no| f2["a, b = b, a % b "]-->if
```
公式:
$$
\iint\limits_{x^2 + y^2 \leq R^2} f(x,y)\,\mathrm{d}x\,\mathrm{d}y = \int_{\theta=0}^{2\pi} \mathrm{d}\theta\int_{r=0}^R f(r\cos\theta,r\sin\theta) r\,\mathrm{d}r\, \tag{1}
$$
还有支持其他语法特性功能,这里不再展示,请参考Typora的语法库。
-
安装前,请确保您已经安装 Typora 或其他 markdown 编辑器(也可以用某些 IDLE),并拥有基本的 markdown 语法知识;
-
最简单的安装办法是在该GitHub页面的右侧找到最新的(或较早的正式版)release,然后下载
Source code (zip)
(推荐!);release中也包含了单独的
.css
样式文件,如果您之前已经安装过该主题,不需要重复下载字体文件和样例文件,可以仅下载.css
,这会大大减小下载大小(如果您是首次下载使用则并不推荐这么做)。当然你也可以使用命令行下载最新的打包代码(虽然没用,只是可能酷一点?):
$ cd <你常用的下载文件夹> $ git clone https://github.com/Keldos-Li/typora-latex-theme.git
-
解压这个文件,然后将
css
文件夹中的latex.css
和latex-dark.css
两个文件复制到你的 Typora主题文件夹下; -
打开
/Supplemental/Fonts
文件夹,安装需要的字体; -
启动或重新启动 Typora,然后从主题菜单中选择
Latex
或Latex Dark
选项; -
Watch这个项目以获取最新的更新。(可选)
-
在 Typora 的
偏好设置
–Markdown
中选取保留连续的空格与单个换行
(如果您不希望您的论文有段后的额外行距的话); -
按照您学校的要求修改 CSS 文件;(为什么?)
- 修改 CSS 后请重新启动 Typora 以查看效果
-
Supplemental
文件夹中的essay-template.md
和essay-template.pdf
展示了一篇小论文在该主题下的效果(其中文字来源于我本人的课程作业以及一些拼凑,请不要在意过多细节),其中论文封面(也单独放置在cover-template.md
文件中)、摘要、关键词和其他一些特别的元素使用 HTML 代码来编写。您可以自行取用修改它们的文字内容部分和代码部分来完成您的课程论文。- 如果您看不懂 HTML 代码,请先自行百度/谷歌/必应,然后尝试联系您在计算机系的同学;
-
如果可以的话,或许您可以在论文致谢中提到这个项目。(/ω\)
这本质是一个适用于所有 markdown 编辑器的 CSS 样式(但对 Typora 编辑器做了额外的优化),您也可以将其用于其他您喜欢的 markdown 编辑器的自定义样式(尚未经过完整测试)。
-
PDF页面页边距:
在 Windos / Linux 中,您可以很好地使用
@media print{ @page{ margin: 1.8cm 2cm 1.2cm 2cm !important; /* 按次序为 上 右 下 左 的页边距 */ } }
来更改打印 PDF 的页边距。
但对于 macOS 用户,因为 Typora 本身的问题,暂时不能使用这一方法调整页边距。
- 可以在 Typora 的导出设置里重新设置自定义页边距。
- 或先导出为 html ,然后在 Chrome 中打开打印。
(不能用 Safari!Safari 会自行设置它认为的最小边距,这会导致您无法精确控制页边距;另一方面,在某次更新后 Safari 取消了对 CSS 本地字体读取的支持(理由是隐私问题),会导致您无法显示很多字体!) - 或者直接用 pandoc 的命令行设置。
-
超链接:
显然,我们不希望打印的论文存在蓝色的超链接(?),我在 CSS 中修改了部分代码,使得在页面编辑和导出html预览中可以得到正常的超链接样式,但打印时会取消颜色和下划线(仍可以点击链接)。
不知道大家是否有这个需求,如果有更合适的方法可以联系我。
-
多级列表:
因为我的技术原因,请暂时不要在二级有序列表之后混用 有序列表 和 无序列表 以及核对清单,会出现一些 bug。(虽然感觉会这么干的人应该不多。)如果您有解决方案,请联系我。
-
页眉和页脚:
目前似乎不能直接定义,请在 Typora 的导出设置里设置好您需要的页眉和页脚文字,导出后在 PDF 编辑器中调整您喜欢的样式风格。
-
引用参考文献
目前没有更好的方式,请您主动编号……(或许小型课程论文不需要大量参考文献。)
或者我之后可能考虑把markdown注释样式改一下。
-
专注模式和打字机模式:
还没写这部分的代码。本主题样式初衷不在于此,如果您有需求,可以提交 issue 或进入讨论区讨论,我视需求和精力再进行开发。
Typora 是一个超级好用的实时预览markdown编辑器;
markdown 是一种轻量级标记语言,用于使用纯文本创建格式化文本。 约翰·格鲁伯和亚伦·斯沃茨于2004年创建了 Markdown,作为一种以源代码形式吸引人类读者的标记语言。 Markdown 排版语法简洁,让人们更多地关注内容本身而非排版。它可与 HTML 混编,可导出 HTML、PDF 以及本身的 .md 格式等文件。 Markdown 广泛用于博客、即时消息、在线论坛、协作软件、文档页面和阅读文件。
参考:
-
从
文件
–偏好设置
中打开设置面板,然后单击“打开主题文件夹”即可。 -
如果您需要手动打开,对于 Windows / Linux,这个文件夹一般是
C:\Users\{username}\AppData\Roaming\Typora\themes\
;对于 macOS,这个文件夹一般是/Users/{username}/Library/Application Support/abnerworks.Typora/themes/
。
字体文件都存放在/Supplemental/Fonts
文件夹。
具体请参阅这里。
- 所有的字体文件请自行获取授权,本人不对您使用字体造成的法律纠纷负责。
在@font-face
中,我们引入字体文件的路径为相对路径,这样的话一旦我们导出 HTML 文件,嵌入的 CSS 就无法读取字体所在位置(为什么不写绝对路径?因为macOS和Windows路径不同!),导致显示效果不佳。因此安装字体是最好的方法。况且这里使用的大多是必要的规范中文字体,对您的学业百益而无一害;
另外,对大多数已经拥有这些字体的用户来说,在电脑里再放一个文件夹重复放那么多字体(就算是.woff
)也很占用电脑容量。
每个学校所要求的格式略有不同,尽管老师不会肉眼查看您的格式是否符合要求,但或许您为了自己的需要仍需要稍作修改,例如加大字体、行间距和页边距使得论文显得更长。
尽管 Typora 不希望您直接编辑您下载的主题文件,但我暂时推荐您直接修改我们的样式文件,得以充分达到自定义的效果,我为此写了大量的注释。
- 在当前版本中设置点较为分散,我后期应该会将设置点整合到
:root
设置中,届时您将可以直接在 CSS 样式表的最顶端修改。但目前,您不得不记住所有您更改过的位置,并在获取我们之后的更新后重新修改一遍(对不起!🙇🏻)
- 确保您电脑中拥有文本编辑软件,如记事本(Windows)或文本编辑(macOS),如果有代码编辑软件就更好了。如果双击 CSS 文件无法打开,请在系统让您选取应用程序时选取上述软件;
- 绝对不要用 Microsoft Word 打开它!!!就算它可以!
- 根据代码中的注释提示修改源代码中样式选择器的变量取值;
- 如果您看不懂注释,或不知道修改代码会造成什么效果,请先自行百度/谷歌/必应,然后尝试联系我。
该样式只能作为轻量级排版输出,如果您需要更复杂的排版,请使用 LaTeX 或 Word 进行排版。
- 如果您是zjuer:指南
本人呢,本来是打算自己用的,所以 Latin modern 字体文件都直接安装引用了_(:з」∠)_。 相比原作者的代码,其他部分各种部分都重新编写了一点,修改了一点。_(:з」∠)_ 主要改动在于:
- 修订了部分mermaid样式;
- 修改了页面边框样式;
- 增订了较为完整的黑色模式;
- 修改了多级列表编号样式(有一定bug);
- 增加了代码块字体和代码块样式;
- 修改了表格样式;
- 修改了字体样式;
- 整理了代码编写风格使其更美观;
- 增订了大部分注释;(当然我写得很随意啦啦啦)
- 增加了侧边栏字体修改等;
- 其他细节修改。
已知的bug:
- 无编号项目列表有很大的bug!!在二级项目之后,你不能混用有序列表和无序列表!因为全都是重新定义的content,我不能理解它为什么会对子项目产生影响!!可恶!
- 当行间代码太长跨页的时候好像也会有点问题,到时候再改……
- mermaid字体无法修改,我找遍了mermaid的最新文档和Typora的其他样式资源都没找到这个应该怎么在CSS样式表里修改……呜呜呜。
未来的预期的话我应该会搞成前导root定义统一颜色字体字号啥最后引用的,同时加入定义CSS完成摘要和关键词的定制。现在的代码就是东拼西凑的,最后肯定需要整合重构的。
(具体时间不确定。。)
话说论文封面的学校徽标是不是做得太大了(?)你们觉得不合适自己改改就好,就调一个width
的事。
虽然是都开源项目,但这个项目似乎经过三手每个人都重新做了仓库而不是fork😂,不过确实每经一次手都有很多深化和改进orz,感觉目前代码已经没有办法merge了,害。感觉不是很符合开源精神。有点对不起原作者的感觉🥲(虽然我们谈过话)。
以及大家都是咋找到这里的啊,我惊了……我都没宣传 orz(可加群告诉我一下?)
- This theme for Typora is built on Mac, with Typora version 0.10.10 (5354).
该项目最初来自于知乎作者 @让幻想飞 (清华大佬,没想到和我一样年轻,但可能不喜欢及时回消息_(:з」∠)_)
他的原注释:
这篇样式基于知乎大佬LAN DU的样式,
原文知乎链接:https://zhuanlan.zhihu.com/p/158767474
GitHub链接: https://github.com/du33169/typora-theme-essay_cn
主要改动:
适配LaTeX的字体。选用像LaTeX的字体是装“哔”的重要手段。
更改标题、目录和大纲的编号样式。改成1. ,1.1 , 1.1.1 ,……这样的编号更有一种浓厚的论文感觉。
二级及以下标题全部靠左,适应文章样式。后面加上大空白,适配LaTeX样式
不足之处:
- 仍然无法添加页眉页脚。 适用于小论文、实验报告等对格式要求较松的情况,在不写代码的前提下装“哔”
@让幻想飞 的知乎文章地址:https://zhuanlan.zhihu.com/p/357096043
GitHub项目地址: https://github.com/yfzhao20/Typora-markdown