Skip to content

Commit 8876bb8

Browse files
krahetskrahets
committed
Update README
1 parent 2f8829d commit 8876bb8

File tree

10 files changed

+76
-34
lines changed

10 files changed

+76
-34
lines changed

‎README.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,3 +15,23 @@ For full documentation visit [mkdocs.org](https://www.mkdocs.org).
1515
docs/
1616
index.md # The documentation homepage.
1717
... # Other markdown pages, images and other files.
18+
19+
## 更新日志
20+
21+
| 更新内容 | 日期 |
22+
| ------------ | ---------- |
23+
| 新增：算法无处不在 | 2022-10-10 |
24+
| 新增：数组与链表 | 2022-10-15 |
25+
| 新增：数据结构简介 | 2022-10-20 |
26+
| 新增：前言 | 2022-10-23 |
27+
| 新增：计算复杂度 | 2022-11-03 |
28+
| 更新：配图 | 2022-11-04 |
29+
| 新增：数据与内存 | 2022-11-05 |
30+
| 更新：各章节 Java 代码 | 2022-11-06 |
31+
| 更新：列表 Java 代码、配图 | 2022-11-07 |
32+
| 新增：栈与队列 | 2022-11-09 |
33+
| 新增：树 | 2022-11-12 |
34+
| 新增：二叉搜索树</br>更新：二叉树、表格居中 | 2022-11-13 |
35+
| 更新：二叉搜索树 | 2022-11-14 |
36+
| 更新：首页介绍 | 2022-11-15 |
37+
| 更新：关于本书</br>新增：如何使用本书</br>新增：一起参与创作</br>更新：二叉树、表格居中 | 2022-11-16 |

‎docs/assets/images/favicon.png

-12 KB
Loading

‎docs/assets/images/logo.png

8 KB
Loading

‎docs/index.assets/algorithm_animation.gif

503 KB
Loading

‎docs/index.assets/comment.gif

626 KB
Loading

‎docs/index.assets/conceptual_rendering.jpg

276 KB
Loading

‎docs/index.assets/learning_route.png

79.9 KB
Loading

‎docs/index.assets/running_code.gif

491 KB
Loading

‎docs/index.md

Lines changed: 35 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -4,24 +4,38 @@ hide:
44
- footer
55
---
66

7-
# Hello，算法！
8-
9-
TODO
10-
11-
## 更新日志
12-
13-
| 更新内容 | 日期 |
14-
| ------------ | ---------- |
15-
| 新增：算法无处不在 | 2022-10-10 |
16-
| 新增：数组与链表 | 2022-10-15 |
17-
| 新增：数据结构简介 | 2022-10-20 |
18-
| 新增：前言 | 2022-10-23 |
19-
| 新增：计算复杂度 | 2022-11-03 |
20-
| 更新：配图 | 2022-11-04 |
21-
| 新增：数据与内存 | 2022-11-05 |
22-
| 更新：各章节 Java 代码 | 2022-11-06 |
23-
| 更新：列表 Java 代码、配图 | 2022-11-07 |
24-
| 新增：栈与队列 | 2022-11-09 |
25-
| 新增：树 | 2022-11-12 |
26-
| 新增：二叉搜索树，<br />更新：二叉树、表格居中 | 2022-11-13 |
27-
| 更新：二叉搜索树 | 2022-11-14 |
7+
=== " "
8+
9+
<div class="result" markdown>
10+
![conceptual_rendering](index.assets/conceptual_rendering.jpg){ align=left width=300 }
11+
</br>
12+
</br>
13+
</br>
14+
</br>
15+
<h1 style="text-align:center"> 《Hello，算法》 </h1>
16+
<h3 style="text-align:center"> 动画图解、能运行、可讨论的</br>数据结构与算法快速入门教程 </h3>
17+
<h3 style="text-align:center"> [![github-stars](https://img.shields.io/github/stars/krahets/hello-algo?style=social)](https://github.com/krahets/hello-algo) </h3>
18+
</br>
19+
</div>
20+
21+
---
22+
23+
<h2 style="text-align:center"> 「动画 + 图片 + HTML」 </h2>
24+
25+
<p style="text-align:center"> 重点知识以动画和图解为主，提升知识吸收效率</br>MkDocs 文档，可在笔记本、平板、手机等移动端随时学习 </p>
26+
27+
![algorithm_animation](index.assets/algorithm_animation.gif)
28+
29+
<h2 style="text-align:center"> 「面向代码，注重实践」 </h2>
30+
31+
<p style="text-align:center"> 示例代码皆可一键运行，在调试中加深理解</br>提供 Java, C++, Python 源码与详细注释 </p>
32+
33+
![running_code](index.assets/running_code.gif)
34+
35+
<h2 style="text-align:center"> 「可讨论，能提问」 </h2>
36+
37+
<p style="text-align:center"> 在评论区和小伙伴们一起讨论进步</br>作者定期回复评论问题（一般 < 72h ） </p>
38+
39+
![comment](index.assets/comment.gif)
40+
41+
---

‎mkdocs.yml

Lines changed: 21 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ theme:
5151
text: Roboto
5252
code: Roboto Mono
5353
favicon: assets/images/favicon.png
54-
logo: assets/images/favicon.png
54+
logo: assets/images/logo.png
5555
# icon:
5656
# logo: logo
5757

@@ -115,6 +115,10 @@ extra_css:
115115
nav:
116116
- 关于本书:
117117
- chapter_about/index.md
118+
- 如何使用本书: chapter_about/how_to_read.md
119+
- 编程环境安装: chapter_about/installation.md
120+
- 一起参与创作: chapter_about/contribution.md
121+
- License: chapter_about/license.md
118122
- 算法无处不在:
119123
- chapter_introduction/index.md
120124
- 计算复杂度:
@@ -131,22 +135,26 @@ nav:
131135
- 小结: chapter_data_structure/summary.md
132136
- 数组与链表:
133137
- chapter_array_and_linkedlist/index.md
134-
- 数组: chapter_array_and_linkedlist/array.md
135-
- 链表: chapter_array_and_linkedlist/linked_list.md
136-
- 列表: chapter_array_and_linkedlist/list.md
138+
- 数组（Array）: chapter_array_and_linkedlist/array.md
139+
- 链表（LinkedList）: chapter_array_and_linkedlist/linked_list.md
140+
- 列表（List）: chapter_array_and_linkedlist/list.md
137141
- 小结: chapter_array_and_linkedlist/summary.md
138142
- 栈与队列:
139143
- chapter_stack_and_queue/index.md
140-
- 栈: chapter_stack_and_queue/stack.md
141-
- 队列: chapter_stack_and_queue/queue.md
142-
- 双向队列: chapter_stack_and_queue/deque.md
144+
- 栈（Stack）: chapter_stack_and_queue/stack.md
145+
- 队列（Queue）: chapter_stack_and_queue/queue.md
146+
- 双向队列（Deque）: chapter_stack_and_queue/deque.md
143147
- 小结: chapter_stack_and_queue/summary.md
144-
- 树:
148+
- 二叉树:
145149
- chapter_tree/index.md
146-
- 二叉树: chapter_tree/binary_tree.md
147-
- 满二叉树: chapter_tree/perfect_complete_full_binary_tree.md
150+
- 二叉树（Binary Tree）: chapter_tree/binary_tree.md
151+
- 二叉树常见类型: chapter_tree/binary_tree_types.md
148152
- 二叉搜索树: chapter_tree/binary_search_tree.md
149-
- 平衡二叉树: chapter_tree/balanced_binary_tree.md
150153
- 小结: chapter_tree/summary.md
151-
- License:
152-
- chapter_license/index.md
154+
- 查找算法:
155+
- chapter_searching/index.md
156+
- 线性查找: chapter_searching/linear_search.md
157+
- 二分查找: chapter_searching/binary_search.md
158+
- 小结: chapter_searching/summary.md
159+
- 参考文献:
160+
- chapter_reference/index.md

0 commit comments

Comments
 (0)