fix

2018-12-18 21:53:47 +08:00 · 2018-12-18 21:53:47 +08:00 · 17362a0380
commit 17362a0380
parent 68fa14b4e5
2 changed files with 130 additions and 10 deletions
--- a/docs/README.md
+++ b/docs/README.md
@ -1,15 +1,84 @@
-# Headline
-
-> An awesome project.
+|               Ⅰ                |                    Ⅱ                     |             Ⅲ              |                  Ⅳ                   |                     Ⅴ                      |               Ⅵ               |                Ⅶ                 |              Ⅷ               |                         Ⅸ                          |            Ⅹ             |
+| :----------------------------: | :--------------------------------------: | :------------------------: | :----------------------------------: | :----------------------------------------: | :---------------------------: | :------------------------------: | :--------------------------: | :------------------------------------------------: | :----------------------: |
+| 算法[:pencil2:](#pencil2-算法) | 操作系统[:computer:](#computer-操作系统) | 网络[:cloud:](#cloud-网络) | 面向对象[:couple:](#couple-面向对象) | 数据库[:floppy_disk:](#floppy_disk-数据库) | Java [:coffee:](#coffee-java) | 系统设计[:bulb:](#bulb-系统设计) | 工具[:hammer:](#hammer-工具) | 编码实践[:speak_no_evil:](#speak_no_evil-编码实践) | 后记[:memo:](#memo-后记) |


+#### About

-```java
-int a = 1;
-```
+本仓库主要是根据计算机经典书籍以及官方技术文档进行总结的学习笔记，希望对大家有所帮助。

-# H1
+学习笔记不是从网上到处拼凑而来，除了少部分引用书上和技术文档的原文，其余都是笔者的原创。在您引用本仓库内容或者对内容进行修改演绎时，请遵循文末的开源协议，谢谢。

-## H2
+#### How To Contribute

-### H3
+笔记内容是笔者一个字一个字打上去的，难免会有一些笔误，如果发现笔误可直接对相应文档进行编辑修改。
+
+如果想要提交一个仓库现在还没有的全新内容，可以先将相应的文档放到 other 目录下。
+
+欢迎在 Issue 中提交对本仓库的改进建议~
+
+#### BookList
+
+本仓库参考的书目：[BOOKLIST](https://github.com/CyC2018/Interview-Notebook/blob/master/BOOKLIST.md)。
+
+#### Typesetting
+
+笔记内容按照 [中文文案排版指北](https://mazhuang.org/wiki/chinese-copywriting-guidelines/) 进行排版，以保证内容的可读性。
+
+笔记不使用 `![]()` 这种方式来引用图片，而是用 `<img>` 标签。一方面是为了能够控制图片以合适的大小显示，另一方面是因为 GFM 不支持 `<center> ![]() </center>` 让图片居中显示，只能使用 `<div align="center"> <img src=""/> </div>` 达到居中的效果。
+
+笔者将自己实现的文档排版功能提取出来，放在 Github Page 中，无需下载安装即可免费使用：[Text-Typesetting](https://github.com/CyC2018/Markdown-Typesetting)。
+
+#### Uploading
+
+笔者在本地使用为知笔记软件进行书写，为了方便将本地笔记内容上传到 Github 上，实现了一整套自动化上传方案，包括文本文件的导出、提取图片、Markdown 文档转换、Git 同步。
+
+进行 Markdown 文档转换是因为 Github 使用的 GFM 不支持 MathJax 公式和 TOC 标记，所以需要替换 MathJax 公式为 CodeCogs 的云服务和重新生成 TOC 目录。
+
+笔者将自己实现文档转换功能提取出来，方便大家在需要将本地 Markdown 上传到 Github，或者制作项目 README 文档时生成目录时使用：[GFM-Converter](https://github.com/CyC2018/GFM-Converter)。
+
+#### Logo
+
+Power by [logomakr](https://logomakr.com/).
+
+#### Statement
+
+本仓库不参与商业行为，不向读者收取任何费用。(This repository is not engaging in business activities, and does not charge readers any fee.)
+
+#### Acknowledgements
+
+感谢以下人员对本仓库做出的贡献，当然不仅仅只有这些贡献者，这里就不一一列举了。如果你希望被添加到这个名单中，并且提交过 Issue 或者 PR，请与笔者联系。
+
+<a href="https://github.com/linw7">
+    <img src="https://avatars3.githubusercontent.com/u/21679154?s=400&v=4" width="50px">
+</a>  <a href="https://github.com/g10guang">
+    <img src="https://avatars1.githubusercontent.com/u/18458140?s=400&v=4" width="50px">
+</a> 
+<a href="https://github.com/ResolveWang">
+    <img src="https://avatars1.githubusercontent.com/u/8018776?s=400&v=4" width="50px">
+</a>
+<a href="https://github.com/crossoverJie">
+    <img src="https://avatars1.githubusercontent.com/u/15684156?s=400&v=4" width="50px">
+</a> 
+<a href="https://github.com/jy03078584">
+    <img src="https://avatars2.githubusercontent.com/u/7719370?s=400&v=4" width="50px">
+</a>
+<a href="https://github.com/kwongtailau">
+    <img src="https://avatars0.githubusercontent.com/u/22954582?s=400&v=4" width="50px">
+</a>
+<a href="https://github.com/xiangflight">
+    <img src="https://avatars2.githubusercontent.com/u/10072416?s=400&v=4" width="50px">
+</a>
+<a href="https://github.com/mafulong">
+    <img src="https://avatars1.githubusercontent.com/u/24795000?s=400&v=4" width="50px">
+</a>
+<a href="https://github.com/yanglbme">
+    <img src="https://avatars1.githubusercontent.com/u/21008209?s=400&v=4" width="50px">
+</a>
+
+
+#### License
+
+在对本作品进行演绎时，请署名并以相同方式共享。
+
+<a rel="license" href="http://creativecommons.org/licenses/by-nc-sa/4.0/"><img alt="知识共享许可协议" style="border-width:0" src="https://i.creativecommons.org/l/by-nc-sa/4.0/88x31.png" /></a>
--- a/docs/_sidebar.md
+++ b/docs/_sidebar.md
@ -1,2 +1,53 @@
- Getting started
+- 算法

+  - [剑指 Offer 题解](notes/剑指%20offer%20题解.md)
+  - [Leetcode 题解](notes/Leetcode%20题解)
+  - [算法](notes/算法.md)
+
+- 操作系统
+
+  - [计算机操作系统](notes/计算机操作系统.md)
+  - [Linux](notes/Linux.md)
+
+- 网络
+
+  - [计算机网络](notes/计算机网络.md)
+  - [HTTP](notes/HTTP.md)
+  - [Sockets](notes/Sockets.md)
+
+- 面向对象
+
+  - [设计模式](notes/设计模式.md)
+  - [面向对象思想](notes/面向对象思想.md)
+
+- 数据库
+
+  - [数据库系统原理](notes/数据库系统原理.md)
+  - [SQL](notes/SQL.md)
+  - [Leetcode-Database 题解](notes/Leetcode-Database%20题解.md)
+  - [MySQL](notes/MySQL.md)
+  - [Redis](notes/Redis.md)
+
+- Java
+
+  - [Java 基础](notes/Java%20基础.md)
+  - [Java 容器](notes/Java%20容器.md)
+  - [Java 并发](notes/Java%20并发.md)
+  - [Java 虚拟机](notes/Java%20虚拟机.md)
+  - [Java I/O](notes/Java%20IO.md)
+
+- 系统设计
+
+  - [系统设计基础](notes/系统设计基础.md)
+  - [分布式](notes/分布式.md)
+  - [集群](notes/集群.md)
+  - [攻击技术](notes/攻击技术.md)
+  - [缓存](notes/缓存.md)
+  - [消息队列](notes/消息队列.md)
+
+- 工具
+
+  - [Git](notes/Git.md)
+  - [Docker](notes/Docker.md)
+  - [正则表达式](notes/正则表达式.md)
+  - [构建工具](notes/构建工具.md)