Skip to content

Commit

Permalink
doc:update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
du33169 committed Sep 8, 2021
1 parent 079ad95 commit 3fc8cb8
Show file tree
Hide file tree
Showing 9 changed files with 77 additions and 26 deletions.
Binary file added README.assets/codeblock.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Binary file added README.assets/cover_template_sample.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added README.assets/footnote-edit.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added README.assets/footnote-export.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added README.assets/head.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
File renamed without changes
Binary file added README.assets/table.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
103 changes: 77 additions & 26 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,46 +1,97 @@
# typora-theme-essay_cn
一个简单的、为中文课程论文排版设计的[Typora](https://typora.io/)主题。

一个简洁的、为中文课程论文排版设计的[Typora](https://typora.io/)主题。

![Essay效果图](README.assets/preview.png)

## 主题安装

可参见[Typora官方主题文档](http://support.typora.io/About-Themes/)

太长不看版:

0. [在此处](https://github.com/du33169/typora-theme-essay_cn/releases/latest)下载文件,并解压缩
1. 打开Typora
2. 菜单栏“文件”选项卡-偏好设置(<kbd>Ctrl</kbd> +<kbd>,</kbd>)
3. 外观-主题-打开主题文件夹themes
4. 将下载的essay.css文件放入此文件夹
5. 重启Typora,打开论文.md文件
6. 菜单栏“主题”选项卡-Essay

## 特点

1. 各级标题选取合适字体,更加美观
2. 标题自动编号,又有了不必打开Word的理由
3. 图表下方自动编号,专业严谨(图片编号暂无法导出
4. 表格采用三线表,简洁清晰
5. 目录样式覆盖,规范大气
6. A4页面设定,编辑器内所见即所得
7. 提供.md格式的封面模板,写作->导出PDF全过程一处进行
1. A4页面设定,编辑器内所见即所得(除footnote外)
2. 各级标题自动编号,具有合适的不同字体
3. 图表自动编号(参考[Typora支持文档](https://support.typora.io/Auto-Numbering/),图片编号在导出文件中暂无法显示
4. 表格采用三线表
5. [TOC]目录样式调整,不会有突兀的蓝色下划线
6. footnote尾注呈现参考文献格式(自动排序,且可以任意指定标识符)
7. 代码块采用更适合打印和纸质阅读的黑白灰样式

## 文件概述
关于上述特点及其CSS样式,还可见[详细介绍](https://du33169.tech/projects/typoraTheme--Essay.html)

- essay.css:普通Essay等可用主题
- article.css:尝试中的学术论文主题
- cover_template.md:简单的Essay封面模板
## 文件说明

[详细介绍](https://du33169.tech/notes/typoraTheme--Essay.html)
- essay.css:普通课程论文可用主题
- article.css:仿学术期刊主题(更新没那么及时)
- cover_template/cover_template.md:简单的论文封面模板
- essay.docx: 用于导出为word文档的模板

## 安装
## 细节展示

[可参见Typora官方文档](http://support.typora.io/About-Themes/)
### 各级标题及自动编号

太长不看:
![各级标题](README.assets/head.png)

0. [在此处](https://github.com/du33169/typora-theme-essay_cn/releases/latest)下载文件,并解压缩
### 三线表及自动编号

![三线表](README.assets/table.png)

### 尾注参考文献样式

#### 编辑器内

如下是编辑器内样式,可以注意到尾注的标识符可以自定便于查找,而且内容可以直接附在引用位置附近便于编辑;

![尾注,编辑器内](README.assets/footnote-edit.png)

#### 导出效果

如下是导出为PDF后的效果,可以发现自定义的标识符已经自动转换为标号,引用的内容也自动归集到了文章最后:

![尾注,导出效果](README.assets/footnote-export.png)

### 代码块样式

![代码块样式](README.assets/codeblock.png)

## 封面模板

cover_template目录下的cover_template.md为论文封面模板,利用了Markdown对内嵌HTML的支持。复制其中的HTML粘贴到你的Markdown文档开头,并修改校标、校名、论文各项信息,导出时即可拥有美观的封面页。(设置了自动分页,正文内容不会挤到封面中)

### 效果图

![cover](README.assets/cover_template_sample.png)

## Word转换模板

essay.docx是按本主题设计的word模板文件,可以使用pandoc将markdown源文件导出为**基本**符合主题格式的docx文件,命令如下(参见[pandoc's user guide](https://pandoc.org/MANUAL.html#option--reference-doc)):

1. 打开Typora偏好设置(<kbd>Ctrl</kbd> +<kbd>,</kbd>)
```bash
pandoc -i xxx.md --reference-doc essay.docx xxx.docx
```

2. 外观-主题-打开主题文件夹
也可以利用新版typora的自定义导出功能将本命令添加到导出菜单中。

3. 将下载的essay.css文件放入此文件夹
**注意**:导出后请打开导出的word文档检查并调整,pandoc对于公式块、表格、引用等的处理可能不尽如人意。另外在使用该方法时,pandoc会读取essay.docx中设定的**样式**,并应用到输出的文档中。因此essay.docx中显示的可见内容只是效果展示,直接编辑它们并不会改变输出的结果,如有需要请更改样式。

4. 重启Typora,选取essay主题
## 已知问题

## 预览
### 图片自动编号在导出PDF中无法显示

### Essay主题效果图
图表编号样式使用CSS中的伪元素实现,图片导出时仅为HTML<img>标签,该标签不支持伪元素。

![Essay效果图](https://gh-proxy.du33169.workers.dev/https://raw.githubusercontent.com/du33169/typora-theme-essay_cn/master/README.assets/image-20200711161336734.png)
### article样式中公式符号重叠[issue#2](https://github.com/du33169/typora-theme-essay_cn/issues/2)

### 封面模板效果图
该问题只在CSS样式`column-count:2;`生效时出现,猜测是Typora使用的mathjax版本问题。

![cover](README.assets/cover_template_-after-1594443595844.png)

0 comments on commit 3fc8cb8

Please sign in to comment.