From d7d12635ba5c107e4e65ffb26180d0a83ee7e2f9 Mon Sep 17 00:00:00 2001 From: CyC2018 <36260787+CyC2018@users.noreply.github.com> Date: Sun, 18 Mar 2018 23:30:25 +0800 Subject: [PATCH] Update README.md --- README.md | 28 ++++++++++++++++++++++------ 1 file changed, 22 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 4671dfa815..13860167cd 100644 --- a/README.md +++ b/README.md @@ -143,17 +143,33 @@ Google 开源项目的代码风格规范。 ## 后记 :memo: -网上有很多相关的资料，但是这些资料都比较零散。本仓库的笔记是从经典的书籍和材料中整理而来，在整理出重点的同时会尽可能保证知识的系统性，因此比较适合作为应对面试的学习资料。 +### 1. 关于仓库 -笔记内容按照 [中文文案排版指北](http://mazhuang.org/wiki/chinese-copywriting-guidelines/#%E4%B8%8D%E8%A6%81%E4%BD%BF%E7%94%A8%E4%B8%8D%E5%9C%B0%E9%81%93%E7%9A%84%E7%BC%A9%E5%86%99) 进行排版，以保证内容的可读性。这里提供了本人实现的文档排版工具的下载：[Text-Typesetting](https://github.com/CyC2018/Markdown-Typesetting)。 +本仓库是笔者在准备 2018 年春招实习过程中的学习总结，内容以计算机书籍的学习笔记为主，在整理重点知识的同时会尽量保证知识的系统性。 -由于 Github 使用的 GFM 不支持 MathJax 公式，也不支持 TOC 标记，为了把本地的 Markdown 文档转换为 GFM 支持的格式，需要替换 MathJax 公式为 CodeCogs 的云服务和重新生成 TOC 目录。并且为了让图片显示效果更好，笔记内容基本使用了 <center> 标记来让图片居中显示，但是 GFM 却不支持 <center> 标记，因此也需要进行一定的转换。这里提供了本人实现的 GFM 文档转换工具的下载：[GFM-Converter](https://github.com/CyC2018/GFM-Converter)。 +### 2. 关于上传 -因为大部分内容是一个字一个字打上去的，难免会有一些笔误，如果发现，可以直接在相应的文档上编辑修改。 +笔者在本地使用为知笔记软件进行书写，为了方便将本地笔记内容上传到 Github 上，实现了一整套自动化上传方案，包括文本文件的导出、提取图片、Markdown 文档转换、Git 同步。 -如果觉得内容不够完善或者有写的不好的地方，您可以在 Issues 中发表反馈意见。 +进行 Markdown 文档转换的原因是 Github 使用的 GFM 不支持 MathJax 公式，也不支持 TOC 标记，因此需要替换 MathJax 公式为 CodeCogs 的云服务和重新生成 TOC 目录。这里提供了笔者实现的 GFM 文档转换工具的下载：[GFM-Converter](https://github.com/CyC2018/GFM-Converter)。 -笔记内容可供个人随意使用，转载或者引用请注明出处，毕竟写了很长时间没那么轻松~ +### 3. 关于排版 + +笔记内容按照 [中文文案排版指北](http://mazhuang.org/wiki/chinese-copywriting-guidelines/#%E4%B8%8D%E8%A6%81%E4%BD%BF%E7%94%A8%E4%B8%8D%E5%9C%B0%E9%81%93%E7%9A%84%E7%BC%A9%E5%86%99) 进行排版，以保证内容的可读性。这里提供了笔者实现的中英混排文档排版工具的下载：[Text-Typesetting](https://github.com/CyC2018/Markdown-Typesetting)，目前实现了加空格的功能，只能以命令行的方式运行。之后打算实现对英文专有名词提示首字母大写的功能，并做一个用户界面。 + +不使用 `![]()` 这种方式来引用图片的原因是为了能够控制图片以合适的大小显示，并且在 GFM 中无法使用 `
![]()
` 让图片居中显示，只能使用 `
` 达到此目的。 + +## 4. 关于纠错 + +大部分内容是一个字一个字打上去的，难免会有一些笔误。如果发现，可以直接在相应的文档上编辑修改。 + +笔者也处于学习的过程中，如果您发现错误，希望您能够进行指正，谢谢！ + +您也可以在 Issues 中发表反馈意见。 + +## 5. 关于转载 + +本仓库内容使用到的资料都会在最后面的参考资料中给出引用链接，希望您在使用本仓库的内容时也能给出相应的引用链接，毕竟毕竟写了很长时间没那么轻松~