Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
Former-commit-id: 7f5017d
  • Loading branch information
RalXYZ committed Aug 24, 2021
1 parent 9d75609 commit 9f35292
Showing 1 changed file with 42 additions and 24 deletions.
66 changes: 42 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
![cover](./Supplemental/cover.png)
# Typora伪装LaTeX中文样式主题

[预览](#预览) | [安装与使用](#安装与使用) | [下载与版本日志](releases) | [个性化设置](#个性化设置) | [面向高级用户](#面向高级用户) | [常见问题](常见) | [已知 bug](#已知-bug)
[预览](#预览) | [安装与使用](#安装与使用) | [下载与版本日志](releases) | [个性化设置](#个性化设置) | [面向高级用户](#面向高级用户) | [常见问题](常见问题) | [已知 bug](#已知-bug)

本项目的初衷是为了简化中国大陆本科生**小型通识课论文**(或**小型实验报告**)撰写的负担。这里基本采用了浙江大学要求的格式(字体较小,页边距较小),但大部分同学都可以自行在 CSS 中修改适合自己学校的格式。

Expand Down Expand Up @@ -90,17 +90,23 @@ $$

## 安装与使用

1. 安装本主题前,**请确保您已经安装 Typora**. 如果您不清楚 Typora 是什么,这里[有一段介绍](#什么是-typora)。如果您对 markdown 的语法还不了解,[您可以从这里获得帮助](#什么是-markdown)
1. 安装本主题前,**请确保您已经安装 Typora**. 如果您不清楚 Typora 是什么,这里有[一段介绍](#什么是-typora)。如果您对 markdown 的语法还不了解,您可以从这里[获得帮助](#什么是-markdown)

2. 前往本项目的 [release](release) 页面,然后下载最新版本的 `latex-theme.zip`.

3. 解压缩这个文件。如果您正在使用 Windows 操作系统,请运行 `install.ps1` 文件。如果您正在使用 macOS ,请运行 `install.sh` 文件。运行上述文件后,适合您当前操作系统的 Typora 主题会被自动安装。如果您是要更新这个主题,以上的过程仍然有效;**新的主题文件会自动覆盖旧的主题文件**
3. 解压缩这个文件,并进入解压缩后的文件夹。在这个文件夹里,请运行符合您操作系统的脚本文件:

5. 如果您需要下载字体,请在 [release](release) 页面下载 `fonts.zip`,解压缩后即可安装您[需要的字体](#该主题都包含了哪些字体)
- 如果您正在使用 Windows 操作系统,请运行 `install.ps1` 文件。具体的运行方式是:右键点击 `install.ps1` 文件,然后点击“使用 PowerShell 运行”。
- 如果您正在使用 macOS ,请运行 `install.sh` 文件。具体的运行方式是:打开*终端*,将 `install.sh` 文件拖入终端窗口中。如果您不知道如何打开终端,这里有[一份介绍](#macos-如何打开终端)
- 本主题目前没有对 Linux 的完善支持。如果您在使用 Linux ,且愿意体验本主题,您也可以通过运行 `install.sh` 的方式进行安装。

6. 启动或重新启动 Typora,然后在菜单栏的**主题**下拉菜单中选择 `Latex` 或 `Latex Dark` 选项
5. 如果您是要更新这个主题,以上的过程仍然有效;**新的主题文件会自动覆盖旧的主题文件**

7. 本项目会持续更新,所以您可以选择点击本仓库的 `watch` 按钮(此按钮在 GitHub 网页版的右上方),从而实时跟进这个项目的更新信息。*(可选)*
6. 如果您需要下载字体,您可以在 [Keldos-Li/typora-latex-theme-fonts](https://github.com/Keldos-Li/typora-latex-theme-fonts) 仓库下载并安装您[需要的字体](#该主题都包含了哪些字体)

7. 启动或重新启动 Typora,然后在菜单栏的**主题**下拉菜单中选择 `Latex` 或 `Latex Dark` 选项。

8. 本项目会持续更新,所以您可以选择点击本仓库的 `watch` 按钮(此按钮在 GitHub 网页版的右上方),从而实时跟进这个项目的更新信息。*(可选)*

### 使用封面

Expand All @@ -113,7 +119,16 @@ $$

## 个性化设置

在完成安装后,您可以选择按照学校的要求[进行个性化设置](#为什么要个性化设置?)。根据代码中的注释提示修改变量取值。在这里您可以轻松地更换正文、标题等不同元素的字体、字号、行距、页边距等。
在完成安装后,您可以选择[按照学校的要求进行个性化设置](#为什么要个性化设置)。在 CSS 文件中,您可以根据代码中的注释提示修改变量取值,轻松地更换正文、标题等不同元素的字体、字号、行距、页边距等:

```css
/* 代码字体(代码中的中文会调用ui-font) */
--code-font: "Latin Modern Mono", "Latin Modern Mono 10"; /* 您可以修改这里的值 */
/* 侧边栏字体 */
--ui-font: "阿里巴巴普惠体 2.0"; /* 您可以修改这里的值 */
/* source mode 字体 */
--sourceMode-font: "SF Mono", "阿里巴巴普惠体 2.0"; /* 您可以修改这里的值 */
```

进行个性化设置有两种方案:
1. 您可以直接在您下载的安装包中进行修改。比如,如果您目前在使用 Windows 操作系统,且您想修改亮色主题的主题文件,那您就应该打开 `Windows/latex.css`**在完成修改后,请重新执行与您操作系统相匹配的脚本(`install.ps1``install.sh`),并重新启动 Typora,以应用您的更改**
Expand All @@ -131,31 +146,30 @@ $$
若要修改页边距,您首先需要打开您想要修改的 CSS 文件。您需要在这个 CSS 文件中,分别找到两段类似这样的代码:

```css
@media screen {
#write {
padding: 1.8cm 2cm 1.2cm 2cm !important;
/* 按次序为 上 右 下 左 的页边距 */
/* == 页面设置 == */
/* 打印页边距 */
--set-margin: 1.8cm 2cm 1.2cm 2cm !important;
```

```css
@media print {
@page {
/* size: A4; 强制A4大小 */
margin: 1.8cm 2cm 1.2cm 2cm !important;
/* 按次序为 上 右 下 左 的页边距 */
@media print {
@page {
/* size: A4; 强制A4大小 */
margin: 1.8cm 2cm 1.2cm 2cm !important;
/* 按次序为 上 右 下 左 的页边距 */
```

真实的代码内容可能与以上描述不完全相同,但是嵌套关系一定是相同的。推荐您搜索`1.8cm`这个关键词,从而快速找到这两段代码。
真实的代码内容可能与以上描述不完全相同,但是嵌套关系一定是相同的。推荐您搜索`页边距`这个关键词,从而快速找到这两段代码。
以上的第一处的设置调整了 Typora 预览界面包括导出 HTML 时的页面边距,第二处调整了 Typora 导出 PDF 时的页边距。

Windows 中,您在两个 CSS 文件中同时修改页边距后即可导出正确的页面。

**但对于 macOS 用户,因为 [Typora 本身的问题](https:https://github.com/typora/typora-issues/issues/998),第二处设置无效**。也就是说,第一处设置能够保证编辑预览时的页面边距正确,但直接导出时的页面边距无法精确修改。只能通过以下的办法:

* 在 Typora 的导出设置里自定义页边距。
* 先导出为 HTML ,然后在 Chrome 中打开打印。请注意,**不能用 Safari**!Safari 会自行设置它认为的最小边距,这会导致您无法精确控制页边距;另一方面,在某次更新后 Safari 取消了对 CSS 本地字体读取的支持(理由是隐私问题),会导致您无法显示很多字体!
* 直接用 pandoc 的命令行导出。

* **超链接**:

显然,我们不希望打印的论文存在蓝色的超链接(?),我在 CSS 中修改了部分代码,使得在页面编辑和导出 HTML 预览中可以得到正常的超链接样式,但打印时会取消颜色和下划线(仍可以点击链接)。
Expand Down Expand Up @@ -221,7 +235,7 @@ Markdown 广泛用于博客、即时消息、在线论坛、协作软件、文

### 该主题都包含了哪些字体?

字体文件都存放在`/Fonts`文件夹,详情请参阅[字体帮助](./Fonts/README.md)。**所有的字体文件请自行获取授权**,本人不对您使用字体造成的法律纠纷负责。
字体文件都存放在 [Keldos-Li/typora-latex-theme-fonts](https:https://github.com/Keldos-Li/typora-latex-theme-fonts) 仓库,详情请参阅[字体帮助](https:https://github.com/Keldos-Li/typora-latex-theme-fonts/blob/main/README.md)。**所有的字体文件请自行获取授权**,本人不对您使用字体造成的法律纠纷负责。

### 为什么要个性化设置?

Expand All @@ -236,6 +250,10 @@ Markdown 广泛用于博客、即时消息、在线论坛、协作软件、文
* [基于本项目二次开发的适配](https:https://github.com/KuangjuX/TJU-typora-latex-theme)
* [LaTeX指南](https:https://github.com/twtstudio/TJUThesisLatexTemplate)

### macOS 如何打开终端?

打开[启动台](https:https://support.apple.com/zh-cn/HT202635);在启动台顶部的搜索栏里,搜索“终端”,然后点击搜索结果中的终端图标。

## 已知 bug

* 在 Windows 下将 Typora 设置为“一体化”后,darkmodeCSS 暂时无法对设置页面进行背景修改。
Expand Down

0 comments on commit 9f35292

Please sign in to comment.