Skip to content

Commit

Permalink
Improve the landing page, mindmap and pull request template (#1053)
Browse files Browse the repository at this point in the history
* Add the hero image.

* Remove code badges from the landing page

* Update the style of the mindmap

* Update the quote of knowledge sharing

* Fix a type

* Update the pull request template

* Update index.md of docs-en
  • Loading branch information
krahets authored Jan 17, 2024
1 parent f2b283b commit 0d294b1
Show file tree
Hide file tree
Showing 8 changed files with 21 additions and 55 deletions.
13 changes: 9 additions & 4 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
If this PR is related to coding or code translation, please fill out the checklist and paste the console outputs to the PR.
If this pull request (PR) pertains to **Chinese-to-English translation**, please confirm that you have read the contribution guidelines and complete the checklist below:

- [ ] I've tested the code and ensured the outputs are the same as the outputs of reference code.
- [ ] I've checked the code (formatting, comments, indentation, file header, etc) carefully.
- [ ] The code does not rely on a particular environment or IDE and can be executed on a standard system (Win, macOS, Ubuntu).
- [ ] This PR represents the translation of a single, complete document, or contains only bug fixes.
- [ ] The translation accurately conveys the original meaning and intent of the Chinese version. If deviations exist, I have provided explanatory comments to clarify the reasons.

If this pull request (PR) is associated with **coding or code transpilation**, please attach the relevant console outputs to the PR and complete the following checklist:

- [ ] I have thoroughly reviewed the code, focusing on its formatting, comments, indentation, and file headers.
- [ ] I have confirmed that the code execution outputs are consistent with those produced by the reference code (Python or Java).
- [ ] The code is designed to be compatible on standard operating systems, including Windows, macOS, and Ubuntu.
Binary file modified docs-en/index.assets/hello_algo_header.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs-en/index.assets/hello_algo_hero.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
30 changes: 5 additions & 25 deletions docs-en/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,11 @@ hide:
- edit
---

<div class="header-img-div" style="max-width: 500px;">
<img src="index.assets/conceptual_rendering.png" style="width: 37%; height: auto;">
<img src="index.assets/hello_algo_mindmap_tp.png" style="width: 63%; height: auto;">
<div class="header-img-div" style="max-width: 600px;">
<img src="index.assets/hello_algo_header.png" style="width: 100%; height: auto; margin-left: 15px; margin-right: 15px;">
</div>

<h2 align="center">Hello Algo</h2>
<h2 align="center" style="margin-top: 25px;">Hello Algo</h2>

<p align="center">Data Structures and Algorithms Crash Course with Animated Illustrations and Off-the-Shelf Code</p>

Expand Down Expand Up @@ -45,30 +44,12 @@ hide:
</a>
</p>

<p align="center">
<img src="https://img.shields.io/badge/Python-snow?logo=python&logoColor=3776AB">
<img src="https://img.shields.io/badge/C%2B%2B-snow?logo=c%2B%2B&logoColor=00599C">
<img src="https://img.shields.io/badge/Java-snow?logo=coffeescript&logoColor=FC4C02">
<img src="https://img.shields.io/badge/C%23-snow?logo=csharp&logoColor=512BD4">
<img src="https://img.shields.io/badge/Go-snow?logo=go&logoColor=00ADD8">
<img src="https://img.shields.io/badge/Swift-snow?logo=swift&logoColor=F05138">
<img src="https://img.shields.io/badge/JavaScript-snow?logo=javascript&logoColor=E9CE30">
<img src="https://img.shields.io/badge/TypeScript-snow?logo=typescript&logoColor=3178C6">
<img src="https://img.shields.io/badge/Dart-snow?logo=dart&logoColor=0175C2">
<img src="https://img.shields.io/badge/Rust-snow?logo=rust&logoColor=000000">
<img src="https://img.shields.io/badge/C-snow?logo=c&logoColor=A8B9CC">
<img src="https://img.shields.io/badge/Zig-snow?logo=zig&logoColor=F7A41D">
<img src="https://img.shields.io/badge/Stay%20Tuned-snow">
</p>

<div class="admonition example" style="max-width: 800px;margin: 0 auto;">
<p class="admonition-title">The English edition is brewing...</p>
<p>Feel free to engage in Chinese-to-English translation and pull request review! For guidelines, please see <a href="https://github.com/krahets/hello-algo/issues/914">#914</a>.</p>
</div>

---

<h3 align="center">Endorsements</h3>
<img src="index.assets/hello_algo_hero.jpg" class="cover-image" style="width: 100%; margin-top: 27px;">

<div style="display: flex;">
<div class="admonition quote" style="flex: 1; margin-right: 0.4rem;">
Expand Down Expand Up @@ -127,8 +108,7 @@ hide:
</div>

<div class="admonition quote">
<p align="center">"Chase the wind and moon, never stopping"</p>
<p align="center">"Beyond the plains, there are spring mountains"</p>
<p align="center">"Knowledge increases by sharing."</p>
</div>

---
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/index.assets/hello_algo_hero.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
31 changes: 6 additions & 25 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,11 @@ hide:
- edit
---

<div class="header-img-div" style="max-width: 500px;">
<img src="index.assets/conceptual_rendering.png" style="width: 37%; height: auto; margin-left: 15px; margin-right: 15px;">
<img src="index.assets/hello_algo_mindmap_tp.png" style="width: 63%; height: auto; margin-left: 15px; margin-right: 15px;">
<div class="header-img-div" style="max-width: 600px;">
<img src="index.assets/hello_algo_header.png" style="width: 100%; height: auto; margin-left: 15px; margin-right: 15px;">
</div>

<h2 align="center">《 Hello 算法 》</h2>
<h2 align="center" style="margin-top: 25px;">《 Hello 算法 》</h2>

<p align="center">动画图解、一键运行的数据结构与算法教程</p>

Expand Down Expand Up @@ -45,25 +44,7 @@ hide:
</a>
</p>

<p align="center">
<img src="https://img.shields.io/badge/Python-snow?logo=python&logoColor=3776AB">
<img src="https://img.shields.io/badge/C%2B%2B-snow?logo=c%2B%2B&logoColor=00599C">
<img src="https://img.shields.io/badge/Java-snow?logo=coffeescript&logoColor=FC4C02">
<img src="https://img.shields.io/badge/C%23-snow?logo=csharp&logoColor=512BD4">
<img src="https://img.shields.io/badge/Go-snow?logo=go&logoColor=00ADD8">
<img src="https://img.shields.io/badge/Swift-snow?logo=swift&logoColor=F05138">
<img src="https://img.shields.io/badge/JavaScript-snow?logo=javascript&logoColor=E9CE30">
<img src="https://img.shields.io/badge/TypeScript-snow?logo=typescript&logoColor=3178C6">
<img src="https://img.shields.io/badge/Dart-snow?logo=dart&logoColor=0175C2">
<img src="https://img.shields.io/badge/Rust-snow?logo=rust&logoColor=000000">
<img src="https://img.shields.io/badge/C-snow?logo=c&logoColor=A8B9CC">
<img src="https://img.shields.io/badge/Zig-snow?logo=zig&logoColor=F7A41D">
<img src="https://img.shields.io/badge/Stay%20Tuned-snow">
</p>

---

<h3 align="center">推荐语</h3>
<img src="index.assets/hello_algo_hero.jpg" class="cover-image" style="width: 100%; margin-top: 27px;">

<div style="display: flex;">
<div class="admonition quote" style="flex: 1; margin-right: 0.4rem;">
Expand Down Expand Up @@ -124,8 +105,8 @@ hide:
</div>

<div class="admonition quote">
<p align="center">"追风赶月莫停留"</p>
<p align="center">“平芜尽处是春山”</p>
<p align="center">"Knowledge increases by sharing."</p>
<p align="center">“知识在分享中得以增长”</p>
</div>

---
Expand Down
2 changes: 1 addition & 1 deletion overrides/stylesheets/extra.css
Original file line number Diff line number Diff line change
Expand Up @@ -68,9 +68,9 @@
width: 28rem;
height: auto;
border-radius: 0.3rem;
box-shadow: var(--md-shadow-z2);
display: block;
margin: 0 auto;
box-shadow: var(--md-shadow-z2);
}

/* Center Markdown Tables (requires md_in_html extension) */
Expand Down

0 comments on commit 0d294b1

Please sign in to comment.