|
1 | | -# 码志 |
| 1 | +# Cathy 的博客 |
2 | 2 |
|
3 | | -我的个人博客：<https://mazhuang.org>，欢迎 Star 和 Fork。 |
4 | | - |
5 | | -## 概览 |
6 | | - |
7 | | -<!-- vim-markdown-toc GFM --> |
8 | | - |
9 | | -* [效果预览](#效果预览) |
10 | | -* [Fork 指南](#fork-指南) |
11 | | -* [使用文档](#使用文档) |
12 | | -* [经验与思考](#经验与思考) |
13 | | -* [联系我](#联系我) |
14 | | -* [致谢](#致谢) |
15 | | - |
16 | | -<!-- vim-markdown-toc --> |
17 | | - |
18 | | -## 效果预览 |
19 | | - |
20 | | -**[在线预览 →](https://mazhuang.org)** |
21 | | - |
22 | | - |
23 | | - |
24 | | -## Fork 指南 |
25 | | - |
26 | | -Fork 本项目之后，还需要做一些事情才能让你的页面「正确」跑起来。 |
27 | | - |
28 | | -1. 正确设置项目名称与分支。 |
29 | | - |
30 | | - 按照 GitHub Pages 的规定，名称为 `username.github.io` 的项目的 master 分支，或者其它名称的项目的 gh-pages 分支可以自动生成 GitHub Pages 页面。 |
31 | | - |
32 | | -2. 修改域名。 |
33 | | - |
34 | | - 如果你需要绑定自己的域名，那么修改 CNAME 文件的内容；如果不需要绑定自己的域名，那么删掉 CNAME 文件。 |
35 | | - |
36 | | -3. 修改配置。 |
37 | | - |
38 | | - 网站的配置基本都集中在 \_config.yml 文件中，将其中与个人信息相关的部分替换成你自己的，比如网站的 url、title、subtitle 和第三方评论模块的配置等。 |
39 | | - |
40 | | - **评论模块：** 目前支持 disqus、gitment 和 gitalk，选用其中一种就可以了，推荐使用 gitalk。它们各自的配置指南链接在 \_config.yml 文件的 Comments 一节里都贴出来了。 |
41 | | - |
42 | | - **注意：** 如果使用 disqus，因为 disqus 处理用户名与域名白名单的策略存在缺陷，请一定将 disqus.username 修改成你自己的，否则请将该字段留空。我对该缺陷的记录见 [Issues#2][3]。 |
43 | | - |
44 | | -4. 删除我的文章与图片。 |
45 | | - |
46 | | - 如下文件夹中除了 template.md 文件外，都可以全部删除，然后添加你自己的内容。 |
47 | | - |
48 | | - * \_posts 文件夹中是我已发布的博客文章。 |
49 | | - * \_drafts 文件夹中是我尚未发布的博客文章。 |
50 | | - * \_wiki 文件夹中是我已发布的 wiki 页面。 |
51 | | - * images 文件夹中是我的文章和页面里使用的图片。 |
52 | | - |
53 | | -5. 修改「关于」页面。 |
54 | | - |
55 | | - pages/about.md 文件内容对应网站的「关于」页面，里面的内容多为个人相关，将它们替换成你自己的信息，包括 \_data 目录下的 skills.yml 和 social.yml 文件里的数据。 |
56 | | - |
57 | | -## 使用文档 |
58 | | - |
59 | | -- [本博客模板常见问题 Q & A](https://mazhuang.org/2020/05/03/blog-template-qna/)。 |
60 | | - |
61 | | -- 在本地预览博客效果可以参考 [Setting up your Pages site locally with Jekyll][2]。 |
62 | | - |
63 | | -## 经验与思考 |
64 | | - |
65 | | -* 排版建议遵照一定的规范，推荐 [中文文案排版指北（简体中文版）][1]。 |
66 | | - |
67 | | -* 简约，尽量每个页面都不展示多余的内容。 |
68 | | - |
69 | | -* 有时一图抵千言，有时可能只会拖慢网页加载速度。 |
70 | | - |
71 | | -* 言之有物，不做无痛之呻吟。 |
72 | | - |
73 | | -* 如果写技术文章，那先将技术原理完全理清了再开始写，一边摸索技术一边组织文章效率较低。 |
74 | | - |
75 | | -* 杜绝难断句、难理解的长句子，如果不能将其拆分成几个简洁的短句，说明脑中的理解并不清晰。 |
76 | | - |
77 | | -* 可以学习一下那些高质量的博主，他们的行文，内容组织方式，有什么值得借鉴的地方。 |
78 | | - |
79 | | -## 联系我 |
80 | | - |
81 | | -如果对本博客模板或者内容有任何建议，可以通过 [Issues](https://github.com/mzlogin/mzlogin.github.io/issues) 或者微信公众号「闷骚的程序员」与我取得联系。 |
82 | | - |
83 | | -<img width="192px" height="192px" src="https://mazhuang.org/assets/images/qrcode.jpg"/> |
84 | | - |
85 | | -## 致谢 |
86 | | - |
87 | | -本博客外观基于 [DONGChuan](https://dongchuan.github.io) 修改，感谢！ |
88 | | - |
89 | | -Thanks for JetBrains' support. |
90 | | - |
91 | | -<a href="https://www.jetbrains.com/?from=mzlogin.github.io"><img src="./assets/images/jetbrains.svg"/></a> |
92 | | - |
93 | | -[1]: https://github.com/mzlogin/chinese-copywriting-guidelines |
94 | | -[2]: https://help.github.com/articles/setting-up-your-pages-site-locally-with-jekyll/ |
95 | | -[3]: https://github.com/mzlogin/mzlogin.github.io/issues/2 |
| 3 | +README... |
0 commit comments