diff --git a/README.md b/README.md index d36e38183..4db8db467 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,34 @@ -# Welcome to MkDocs +# Hello,算法 -For full documentation visit [mkdocs.org](https://www.mkdocs.org). +

-## Commands +

《 Hello,算法 》

-* `mkdocs new [dir-name]` - Create a new project. -* `mkdocs serve` - Start the live-reloading docs server. -* `mkdocs build` - Build the documentation site. -* `mkdocs -h` - Print help message and exit. +

动画图解、能运行、可讨论的
数据结构与算法快速入门教程

-## Project layout +

[![github-stars](https://img.shields.io/github/stars/krahets/hello-algo?style=social)](https://github.com/krahets/hello-algo)

- mkdocs.yml # The configuration file. - docs/ - index.md # The documentation homepage. - ... # Other markdown pages, images and other files. +--- + +

「动画 + 图片 + HTML」

+ +

重点知识以动画和图解为主,提升知识吸收效率
由 MkDocs 构建文档,支持笔记本、平板、手机多种终端

+ +![algorithm_animation](docs/index.assets/algorithm_animation.gif) + +

「面向代码,注重实践」

+ +

示例代码皆可一键运行,在调试中加深理解
提供 Java, C++, Python 源码与详细注释

+ +![running_code](docs/index.assets/running_code.gif) + +

「可讨论,能提问」

+ +

在评论区和小伙伴们一起讨论进步
作者定期回复评论问题(一般 < 72h )

+ +![comment](docs/index.assets/comment.gif) + +--- ## 更新日志 diff --git a/docs/index.md b/docs/index.md index e5a18ee0c..219448fd9 100644 --- a/docs/index.md +++ b/docs/index.md @@ -22,7 +22,7 @@ hide:

「动画 + 图片 + HTML」

-

重点知识以动画和图解为主,提升知识吸收效率
MkDocs 文档,可在笔记本、平板、手机等移动端随时学习

+

重点知识以动画和图解为主,提升知识吸收效率
由 MkDocs 构建文档,支持笔记本、平板、手机多种终端

![algorithm_animation](index.assets/algorithm_animation.gif) diff --git a/mkdocs.yml b/mkdocs.yml index 902fb206b..8ada6a685 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -125,7 +125,7 @@ nav: - 算法效率评估: chapter_computational_complexity/performance_evaluation.md - 时间复杂度: chapter_computational_complexity/time_complexity.md - 空间复杂度: chapter_computational_complexity/space_complexity.md - - 权衡时间与空间 *: chapter_computational_complexity/space_time_tradeoff.md + - 权衡时间与空间: chapter_computational_complexity/space_time_tradeoff.md - 小结: chapter_computational_complexity/summary.md - 数据结构简介: - 数据与内存: chapter_data_structure/data_and_memory.md @@ -134,7 +134,7 @@ nav: - 数组与链表: - 数组(Array): chapter_array_and_linkedlist/array.md - 链表(LinkedList): chapter_array_and_linkedlist/linked_list.md - - 列表(List)*: chapter_array_and_linkedlist/list.md + - 列表(List): chapter_array_and_linkedlist/list.md - 小结: chapter_array_and_linkedlist/summary.md - 栈与队列: - 栈(Stack): chapter_stack_and_queue/stack.md