Update README.md

This commit is contained in:
krahets 2022-11-21 04:09:37 +08:00
parent f6ad1411f4
commit f9ac33097d
3 changed files with 29 additions and 15 deletions

View File

@ -1,20 +1,34 @@
# Welcome to MkDocs # Hello算法
For full documentation visit [mkdocs.org](https://www.mkdocs.org). <p style="text-align:center"> <img src="docs/index.assets/conceptual_rendering.jpg" width="300"/> </p>
## Commands <h1 style="text-align:center"> 《 Hello算法 》 </h1>
* `mkdocs new [dir-name]` - Create a new project. <h3 style="text-align:center"> 动画图解、能运行、可讨论的</br>数据结构与算法快速入门教程 </h3>
* `mkdocs serve` - Start the live-reloading docs server.
* `mkdocs build` - Build the documentation site.
* `mkdocs -h` - Print help message and exit.
## Project layout <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>
mkdocs.yml # The configuration file. ---
docs/
index.md # The documentation homepage. <h2 style="text-align:center"> 「动画 + 图片 + HTML」 </h2>
... # Other markdown pages, images and other files.
<p style="text-align:center"> 重点知识以动画和图解为主,提升知识吸收效率</br>由 MkDocs 构建文档,支持笔记本、平板、手机多种终端 </p>
![algorithm_animation](docs/index.assets/algorithm_animation.gif)
<h2 style="text-align:center"> 「面向代码,注重实践」 </h2>
<p style="text-align:center"> 示例代码皆可一键运行,在调试中加深理解</br>提供 Java, C++, Python 源码与详细注释 </p>
![running_code](docs/index.assets/running_code.gif)
<h2 style="text-align:center"> 「可讨论,能提问」 </h2>
<p style="text-align:center"> 在评论区和小伙伴们一起讨论进步</br>作者定期回复评论问题(一般 < 72h </p>
![comment](docs/index.assets/comment.gif)
---
## 更新日志 ## 更新日志

View File

@ -22,7 +22,7 @@ hide:
<h2 style="text-align:center"> 「动画 + 图片 + HTML」 </h2> <h2 style="text-align:center"> 「动画 + 图片 + HTML」 </h2>
<p style="text-align:center"> 重点知识以动画和图解为主,提升知识吸收效率</br>MkDocs 文档,可在笔记本、平板、手机等移动端随时学习 </p> <p style="text-align:center"> 重点知识以动画和图解为主,提升知识吸收效率</br>由 MkDocs 构建文档,支持笔记本、平板、手机多种终端 </p>
![algorithm_animation](index.assets/algorithm_animation.gif) ![algorithm_animation](index.assets/algorithm_animation.gif)

View File

@ -125,7 +125,7 @@ nav:
- 算法效率评估: chapter_computational_complexity/performance_evaluation.md - 算法效率评估: chapter_computational_complexity/performance_evaluation.md
- 时间复杂度: chapter_computational_complexity/time_complexity.md - 时间复杂度: chapter_computational_complexity/time_complexity.md
- 空间复杂度: chapter_computational_complexity/space_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_computational_complexity/summary.md
- 数据结构简介: - 数据结构简介:
- 数据与内存: chapter_data_structure/data_and_memory.md - 数据与内存: chapter_data_structure/data_and_memory.md
@ -134,7 +134,7 @@ nav:
- 数组与链表: - 数组与链表:
- 数组Array: chapter_array_and_linkedlist/array.md - 数组Array: chapter_array_and_linkedlist/array.md
- 链表LinkedList: chapter_array_and_linkedlist/linked_list.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 - 小结: chapter_array_and_linkedlist/summary.md
- 栈与队列: - 栈与队列:
- Stack: chapter_stack_and_queue/stack.md - Stack: chapter_stack_and_queue/stack.md