Update README.md
This commit is contained in:
parent
91a6700bd9
commit
01ccbb2cda
44
README.md
44
README.md
@ -1,40 +1,20 @@
|
||||
# Hello,算法
|
||||
# Welcome to MkDocs
|
||||
|
||||
<img src="docs/index.assets/conceptual_rendering.jpg" width="300"/>
|
||||
For full documentation visit [mkdocs.org](https://www.mkdocs.org).
|
||||
|
||||
动画图解、能运行、可讨论的
|
||||
## Commands
|
||||
|
||||
数据结构与算法快速入门教程
|
||||
* `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.
|
||||
|
||||
[![github-stars](https://img.shields.io/github/stars/krahets/hello-algo?style=social)](https://github.com/krahets/hello-algo)
|
||||
## Project layout
|
||||
|
||||
---
|
||||
|
||||
## 「动画 + 图片 + 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)
|
||||
|
||||
---
|
||||
mkdocs.yml # The configuration file.
|
||||
docs/
|
||||
index.md # The documentation homepage.
|
||||
... # Other markdown pages, images and other files.
|
||||
|
||||
## 更新日志
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user