Merge pull request #46 from Keldos-Li/develop

Multiple enhancements related to documentation Former-commit-id: e10f315
Keldos-Li · Nov 26, 2021 · 9976eac · 9976eac
2 parents b3180c1 + 5cb192a
commit 9976eac
Show file tree

Hide file tree

Showing 6 changed files with 57 additions and 78 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,11 @@
+
+
+# 作出贡献
+
+感谢您对 Typora LaTeX Theme 的关注！我们欢迎任何形式的贡献。  
+
+与贡献相关的详细文档可在[贡献指南](https://github.com/Keldos-Li/typora-latex-theme/wiki/%E8%B4%A1%E7%8C%AE%E6%8C%87%E5%8D%97)中找到。这份指南不仅描述了本项目的贡献规范，而且介绍了构建方法和工具链，帮助您快速开始开发。您可能也对本项目的[技术细节](https://github.com/Keldos-Li/typora-latex-theme/wiki/%E6%8A%80%E6%9C%AF%E7%BB%86%E8%8A%82)感兴趣。  
+
+## 获取帮助
+
+如果您遇到了无法解决的问题，您可以前往 GitHub Discussions [发起讨论](https://github.com/Keldos-Li/typora-latex-theme/discussions/new)，或前往 GitHub Issues [报告故障](https://github.com/Keldos-Li/typora-latex-theme/issues/new?labels=bug)、[请求新功能](https://github.com/Keldos-Li/typora-latex-theme/issues/new?labels=Feature+Request)。同时，您也可以使用电子邮件，联系 [Keldos-Li](mailto:[email protected]) 或 [RalXYZ](mailto:[email protected])，或者[加入交流反馈QQ群](https://qm.qq.com/cgi-bin/qm/qr?k=8Vy0m_9-phExgORJKwVTZ2Hix19yScCn&jump_from=webapi)之后和大家一起讨论。
diff --git a/README.md b/README.md
@@ -1,11 +1,11 @@
 ![cover](./Supplemental/cover.png)
 # Typora 伪装 LaTeX 中文样式主题
 
-[预览](#预览) | [安装与使用](#安装与使用) | [下载](https://github.com/Keldos-Li/typora-latex-theme/releases) | [帮助文档](https://github.com/Keldos-Li/typora-latex-theme/wiki) | [个性化设置](https://github.com/Keldos-Li/typora-latex-theme/wiki/%E4%B8%AA%E6%80%A7%E5%8C%96%E8%AE%BE%E7%BD%AE) | [面向高级用户](https://github.com/Keldos-Li/typora-latex-theme/wiki/%E9%9D%A2%E5%90%91%E9%AB%98%E7%BA%A7%E7%94%A8%E6%88%B7) | [常见问题](https://github.com/Keldos-Li/typora-latex-theme/wiki/%E5%B8%B8%E8%A7%81%E9%97%AE%E9%A2%98) | [反馈与贡献](https://github.com/Keldos-Li/typora-latex-theme/wiki#%E5%8F%8D%E9%A6%88%E4%B8%8E%E8%B4%A1%E7%8C%AE)  
+[下载与安装](#下载与安装) | [帮助文档](https://github.com/Keldos-Li/typora-latex-theme/wiki) | [个性化设置](https://github.com/Keldos-Li/typora-latex-theme/wiki/%E4%B8%AA%E6%80%A7%E5%8C%96%E8%AE%BE%E7%BD%AE) | [贡献指南](https://github.com/Keldos-Li/typora-latex-theme/wiki/%E8%B4%A1%E7%8C%AE%E6%8C%87%E5%8D%97) | [技术细节](https://github.com/Keldos-Li/typora-latex-theme/wiki/%E6%8A%80%E6%9C%AF%E7%BB%86%E8%8A%82) | [常见问题](https://github.com/Keldos-Li/typora-latex-theme/wiki/%E5%B8%B8%E8%A7%81%E9%97%AE%E9%A2%98)  
 
 本项目的初衷是为了简化中国大陆本科生**小型通识课论文**（或**小型实验报告**）撰写的负担。这里基本采用了浙江大学要求的格式（字体较小，页边距较小），但大部分同学都可以自行在 CSS 中修改适合自己学校的格式。  
 
-Markdown 的轻量化特性，使您可以专注于论文内容而不用担心格式。书写时仅通过简单的标记，并通过替换样例模板中的个人信息，您就可以输出媲美卷王由 LaTeX 排版的精美论文与报告。本项目支持 Windows, macOS 和 Linux 三大平台的 Typora.  
+Markdown 的轻量化特性，使您可以专注于论文内容而不用担心格式。书写时仅通过简单的标记，并通过替换样例模板中的个人信息，您就可以输出类 LaTeX 排版的精美论文与报告。本项目支持 Windows, macOS 和 Linux 三大平台的 Typora。
 
 <a href="https://github.com/Keldos-Li/typora-latex-theme/releases">![GitHub downloads](https://img.shields.io/github/downloads/Keldos-Li/typora-latex-theme/total?logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABEAAAAVCAYAAACg/AXsAAAAAXNSR0IArs4c6QAAAX1JREFUOE/llLEuBGEUhb+zIaHR8gYapUQUig1RaEg0Wo3GC4hOoaDXKVQ6UXgAoVGIaBRGYiMSXkBDMEf+mdmZf3bWegBTTe5/77nnnnv+Xwz4bE8AF5ImB+XpD5Ap4OQ/gtjeABaA4aCRgUKsb2Ab2CujxWEK7y04lnQm2zuYtW5VLnQJcydp1XYSI0c5IXE3gFwDY7XiikoFUq7RGMU9b+XUSYhEI8T/OUickyXG2XSU2kkeizv8Pk6FUeZ0ZKdJRc98o60h6dT2jeGp1dUEXiW1be8Dy5FJA4iTumuzDvPAC3AqacX2laRZ27PAUY/L+4xTjbuIeFYuAP70HEMcVsfF+CZn0l9U84GWRqRH28FDB801Z5w6xXZqavdYhXNMu9xgv+00jBRvqlnQ26Bg0hW2UVCwi+MNwpkumSb3YMUu/Buv5trHAHIJjAfPxn4pr2CPmn3MdhVA1oGtX5Sv34fmM/gFbGY33vZ0CjMtGB30XMZnKby14FzSww+Jf/H06Zp5zAAAAABJRU5ErkJggg==)</a>
 <a href="https://github.com/Keldos-Li/typora-latex-theme/releases/latest">![GitHub release (latest by date including pre-releases)](https://img.shields.io/github/v/release/Keldos-Li/typora-latex-theme?include_prereleases&color=green&logo=hack-the-box)</a>
@@ -15,7 +15,7 @@ Markdown 的轻量化特性，使您可以专注于论文内容而不用担心
 
 ## 预览
 
-较完整的论文预览见这里: [点我😀](https://blog.keldos.me/2021/05/md-latex-template/)；如果 GitHub 中的图像加载不出来，您也可以查看[我博客上的说明](https://blog.keldos.me/2021/05/typora-latex-css/)。
+较完整的论文预览见[此处](https://blog.keldos.me/2021/05/md-latex-template/)；如果 GitHub 中的图像加载失败，您也可以查看[我博客上的说明](https://blog.keldos.me/2021/05/typora-latex-css/)。另外，请注意链接内博客的更新时间，博文的内容很可能滞后于该项目目前所能提供的特性。
 
 ### 封面，摘要和关键词
 
@@ -30,7 +30,7 @@ Markdown 的轻量化特性，使您可以专注于论文内容而不用担心
 
 #### 层级标题 
 
-|![heading-l](https://gitee.com/Keldos-Li/picture/raw/master/img/heading-l.png)|![](https://gitee.com/Keldos-Li/picture/raw/master/img/heading-d.png)|
+|![heading-l](https://gitee.com/Keldos-Li/picture/raw/master/img/heading-l.png)|![heading-d](https://gitee.com/Keldos-Li/picture/raw/master/img/heading-d.png)|
 | :----: | :----: |
 
 #### 表格 
@@ -85,38 +85,23 @@ $$
 $$
 ```
 
-## 安装与使用
+## 下载与安装
 
-**请完整阅读以下安装过程，以确保一切符合预期。**  
+**请完整阅读以下过程，以确保一切符合预期。**  
 
-1. 安装本主题前，**请确保您已经安装 Typora**. 如果您不清楚 Typora 是什么，这里有[一段介绍](#什么是-typora)。如果您对 markdown 的语法还不了解，您可以从这里[获得帮助](#什么是-markdown)。
+1. [Typora](https://typora.io/) 是一个支持实时预览的 markdown 编辑器。在安装本主题前，请确认您已[下载 Typora](https://typora.io/#download) 并完成了安装。如果您对 markdown 的语法还不了解，您可以从这里[获得帮助](https://github.com/Keldos-Li/typora-latex-theme/wiki/%E5%B8%B8%E8%A7%81%E9%97%AE%E9%A2%98#%E4%BB%80%E4%B9%88%E6%98%AF-markdown)。
 
-2. 前往本项目的 [release](https://github.com/Keldos-Li/typora-latex-theme/releases) 页面，然后下载适合您操作系统的最新版本压缩包。比如，如果您在使用 Windows 操作系统，您就应该下载 `latex-theme-windows.zip`. 
+2. 前往本项目的 [release](https://github.com/Keldos-Li/typora-latex-theme/releases) 页面，下载适合您操作系统的最新版本压缩包。比如，如果您在使用 Windows 操作系统，您就应该下载 `latex-theme-windows.zip`。 
 
-3. 解压缩这个文件，并进入解压缩后的文件夹。按照[在线安装教程](https://github.com/Keldos-Li/typora-latex-theme/wiki/%E5%AE%89%E8%A3%85%E6%95%99%E7%A8%8B)或该文件夹下 `README.md` 中的安装教程**完成剩余的安装步骤**。请务必确认您完成了下面的步骤：
+3. 解压缩这个文件，进入解压缩后的文件夹。按照[在线安装教程](https://github.com/Keldos-Li/typora-latex-theme/wiki/%E5%AE%89%E8%A3%85%E6%95%99%E7%A8%8B)或该文件夹下 `README.md` 中的安装教程**完成剩余的安装步骤**。请务必确认您完成了下面的步骤：
      - [进行手动或自动主题安装](https://github.com/Keldos-Li/typora-latex-theme/wiki/%E5%AE%89%E8%A3%85%E6%95%99%E7%A8%8B#%E5%BC%80%E5%A7%8B%E5%AE%89%E8%A3%85)
      - [下载并安装所需的字体](https://github.com/Keldos-Li/typora-latex-theme/wiki/%E5%AE%89%E8%A3%85%E6%95%99%E7%A8%8B#%E5%AE%89%E8%A3%85%E5%AD%97%E4%BD%93)
 
 
 
 ## 鸣谢
 
-本项目是在下面两人工作的基础上完成的。括号内链接为两人的项目地址：
+本项目是在下面两人工作的基础上完成的：  
 
-[@让幻想飞](https://zhuanlan.zhihu.com/p/357096043)（[yfzhao20](https://github.com/yfzhao20/Typora-markdown)）
-
-> * 适配LaTeX的字体
-> * 更改标题、目录和大纲的编号样式；改成1. ，1.1 ， 1.1.1 ，……这样的编号更有一种浓厚的论文感觉
-> * 二级及以下标题全部靠左，适应文章样式；后面加上大空白，适配LaTeX样式
-
-[@LAN DU](https://zhuanlan.zhihu.com/p/158767474)（[du33169](https://github.com/du33169/typora-theme-essay_cn)）
-
-> 一个简单的、为中文课程论文排版设计的[Typora](https://typora.io/)主题。
->
-> 1.  各级标题选取合适字体，更加美观
-> 2.  标题自动编号，又有了不必打开Word的理由
-> 3.  图表下方自动编号，专业严谨（图片编号暂无法导出）
-> 4.  表格采用三线表，简洁清晰
-> 5.  目录样式覆盖，规范大气
-> 6.  A4页面设定，编辑器内所见即所得
-> 7.  提供.md格式的封面模板，写作->导出PDF全过程一处进行
+- [yfzhao20/Typora-markdown](https://github.com/yfzhao20/Typora-markdown)  
+- [du33169/typora-theme-essay_cn](https://github.com/du33169/typora-theme-essay_cn)  
diff --git a/yfzhao_LICENSE → credits.md b/yfzhao_LICENSE → credits.md
@@ -1,3 +1,33 @@
+# 鸣谢
+
+本项目是在下面两人工作的基础上完成的：  
+
+
+[@让幻想飞](https://zhuanlan.zhihu.com/p/357096043) [yfzhao20/Typora-markdown](https://github.com/yfzhao20/Typora-markdown)  
+
+> 1. 适配LaTeX的字体
+> 2. 更改标题、目录和大纲的编号样式；改成1. ，1.1 ， 1.1.1 ，……这样的编号更有一种浓厚的论文感觉
+> 3. 二级及以下标题全部靠左，适应文章样式；后面加上大空白，适配LaTeX样式
+
+[@LAN DU](https://zhuanlan.zhihu.com/p/158767474) [du33169/typora-theme-essay_cn](https://github.com/du33169/typora-theme-essay_cn)  
+
+> 1.  各级标题选取合适字体，更加美观
+>2.  标题自动编号，又有了不必打开Word的理由
+> 3.  图表下方自动编号，专业严谨（图片编号暂无法导出）
+> 4.  表格采用三线表，简洁清晰
+> 5.  目录样式覆盖，规范大气
+> 6.  A4页面设定，编辑器内所见即所得
+> 7.  提供.md格式的封面模板，写作->导出PDF全过程一处进行
+
+
+
+---
+
+
+**根据开源协议，以下放置协议原文**  
+
+
+```
 % This is the license declared by the origin repository founder yfzhao20.
 % You could see his project here: <https://github.com/yfzhao20/Typora-markdown>
 
@@ -22,3 +52,4 @@ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.
+```
diff --git a/src/Makefile b/src/Makefile
@@ -36,6 +36,8 @@ define build-typora
 		cp $(base_dir)/install.sh $(target_dir)/$(1)-$(typora); \
 	fi;
 	cp $(base_dir)/README.md $(target_dir)/$(1)-$(typora)
+	cp $(base_dir)/../LICENSE $(target_dir)/$(1)-$(typora)
+	cp $(base_dir)/../credits.md $(target_dir)/$(1)-$(typora)
 	cp -r $(base_dir)/../Supplemental $(target_dir)/$(1)-$(typora)/Supplemental
 endef
 

diff --git a/src/latex-theme.scss b/src/latex-theme.scss
@@ -49,29 +49,26 @@
     $chapter-Chinese-font: "华文黑体" !global;
     $sub-chapter-Chinese-font: "华文楷体" !global;
     $sub-sub-chapter-Chinese-font: "华文仿宋" !global;
-    $base-Chinese-font: "华文宋体" !global;
   } @else if $os == "macos" {
     $ui-font: "\"苹方-简\"" !global;
     $heading-Chinese-font: "华文黑体Bold" !global;
     $chapter-Chinese-font: "方正公文黑体" !global;
     $sub-chapter-Chinese-font: "方正公文楷体" !global;
     $sub-sub-chapter-Chinese-font: "方正公文仿宋" !global;
-    $base-Chinese-font: "宋体-简" !global;
   } @else if $os == "linux" {
     $ui-font: "\"Noto Sans CJK SC\"" !global;
     $heading-Chinese-font: "Noto Sans CJK SC" !global;
     $chapter-Chinese-font: "Noto Sans CJK SC" !global;
     $sub-chapter-Chinese-font: "Noto Serif CJK SC" !global;
     $sub-sub-chapter-Chinese-font: "Noto Serif CJK SC" !global;
-    $base-Chinese-font: "Noto Serif CJK SC" !global;
   }
 
   /* == 字体设置 == */
 
   /* 基准字体 */
   /* 备选：Times, "Times New Roman" */
   --base-Latin-font: "Latin Modern Roman", "Latin Modern Roman 10";
-  --base-Chinese-font: "#{$base-Chinese-font}";
+  --base-Chinese-font: "宋体-简", "华文宋体", "Noto Serif CJK SC";
   --base-font-size: 9.5pt;
 
   /* 引言字体 */