Skip to content

Commit

Permalink
Improve compatibility of back to top link (othneildrew#73)
Browse files Browse the repository at this point in the history
  • Loading branch information
@kidonng
kidonng authored Aug 3, 2022
1 parent 3658975 commit 3552467
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 22 deletions.
23 changes: 12 additions & 11 deletions BLANK_README.md
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
<div id="top"></div>
<!-- Improved compatibility of back to top link: See: https://github.com/othneildrew/Best-README-Template/pull/73 -->
<a name="readme-top"></a>
<!--
*** Thanks for checking out the Best-README-Template. If you have a suggestion
*** that would make this better, please fork the repo and create a pull request
Expand Down Expand Up @@ -86,7 +87,7 @@

Here's a blank template to get started: To avoid retyping too much info. Do a search and replace with your text editor for the following: `github_username`, `repo_name`, `twitter_handle`, `linkedin_username`, `email_client`, `email`, `project_title`, `project_description`

<p align="right">(<a href="#top">back to top</a>)</p>
<p align="right">(<a href="#readme-top">back to top</a>)</p>



Expand All @@ -101,7 +102,7 @@ Here's a blank template to get started: To avoid retyping too much info. Do a se
* [![Bootstrap][Bootstrap.com]][Bootstrap-url]
* [![JQuery][JQuery.com]][JQuery-url]

<p align="right">(<a href="#top">back to top</a>)</p>
<p align="right">(<a href="#readme-top">back to top</a>)</p>



Expand Down Expand Up @@ -135,7 +136,7 @@ This is an example of how to list things you need to use the software and how to
const API_KEY = 'ENTER YOUR API';
```

<p align="right">(<a href="#top">back to top</a>)</p>
<p align="right">(<a href="#readme-top">back to top</a>)</p>



Expand All @@ -146,7 +147,7 @@ Use this space to show useful examples of how a project can be used. Additional

_For more examples, please refer to the [Documentation](https://example.com)_

<p align="right">(<a href="#top">back to top</a>)</p>
<p align="right">(<a href="#readme-top">back to top</a>)</p>



Expand All @@ -160,7 +161,7 @@ _For more examples, please refer to the [Documentation](https://example.com)_

See the [open issues](https://github.com/github_username/repo_name/issues) for a full list of proposed features (and known issues).

<p align="right">(<a href="#top">back to top</a>)</p>
<p align="right">(<a href="#readme-top">back to top</a>)</p>



Expand All @@ -178,7 +179,7 @@ Don't forget to give the project a star! Thanks again!
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request

<p align="right">(<a href="#top">back to top</a>)</p>
<p align="right">(<a href="#readme-top">back to top</a>)</p>



Expand All @@ -187,7 +188,7 @@ Don't forget to give the project a star! Thanks again!

Distributed under the MIT License. See `LICENSE.txt` for more information.

<p align="right">(<a href="#top">back to top</a>)</p>
<p align="right">(<a href="#readme-top">back to top</a>)</p>



Expand All @@ -198,7 +199,7 @@ Your Name - [@twitter_handle](https://twitter.com/twitter_handle) - email@email_

Project Link: [https://github.com/github_username/repo_name](https://github.com/github_username/repo_name)

<p align="right">(<a href="#top">back to top</a>)</p>
<p align="right">(<a href="#readme-top">back to top</a>)</p>



Expand All @@ -209,7 +210,7 @@ Project Link: [https://github.com/github_username/repo_name](https://github.com/
* []()
* []()

<p align="right">(<a href="#top">back to top</a>)</p>
<p align="right">(<a href="#readme-top">back to top</a>)</p>



Expand Down Expand Up @@ -243,4 +244,4 @@ Project Link: [https://github.com/github_username/repo_name](https://github.com/
[Bootstrap.com]: https://img.shields.io/badge/Bootstrap-563D7C?style=for-the-badge&logo=bootstrap&logoColor=white
[Bootstrap-url]: https://getbootstrap.com
[JQuery.com]: https://img.shields.io/badge/jQuery-0769AD?style=for-the-badge&logo=jquery&logoColor=white
[JQuery-url]: https://jquery.com
[JQuery-url]: https://jquery.com
23 changes: 12 additions & 11 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
<div id="top"></div>
<!-- Improved compatibility of back to top link: See: https://github.com/othneildrew/Best-README-Template/pull/73 -->
<a name="readme-top"></a>
<!--
*** Thanks for checking out the Best-README-Template. If you have a suggestion
*** that would make this better, please fork the repo and create a pull request
Expand Down Expand Up @@ -95,7 +96,7 @@ Of course, no one template will serve all projects since your needs may be diffe

Use the `BLANK_README.md` to get started.

<p align="right">(<a href="#top">back to top</a>)</p>
<p align="right">(<a href="#readme-top">back to top</a>)</p>



Expand All @@ -112,7 +113,7 @@ This section should list any major frameworks/libraries used to bootstrap your p
* [![Bootstrap][Bootstrap.com]][Bootstrap-url]
* [![JQuery][JQuery.com]][JQuery-url]

<p align="right">(<a href="#top">back to top</a>)</p>
<p align="right">(<a href="#readme-top">back to top</a>)</p>



Expand Down Expand Up @@ -148,7 +149,7 @@ _Below is an example of how you can instruct your audience on installing and set
const API_KEY = 'ENTER YOUR API';
```

<p align="right">(<a href="#top">back to top</a>)</p>
<p align="right">(<a href="#readme-top">back to top</a>)</p>



Expand All @@ -159,7 +160,7 @@ Use this space to show useful examples of how a project can be used. Additional

_For more examples, please refer to the [Documentation](https://example.com)_

<p align="right">(<a href="#top">back to top</a>)</p>
<p align="right">(<a href="#readme-top">back to top</a>)</p>



Expand All @@ -176,7 +177,7 @@ _For more examples, please refer to the [Documentation](https://example.com)_

See the [open issues](https://github.com/othneildrew/Best-README-Template/issues) for a full list of proposed features (and known issues).

<p align="right">(<a href="#top">back to top</a>)</p>
<p align="right">(<a href="#readme-top">back to top</a>)</p>



Expand All @@ -194,7 +195,7 @@ Don't forget to give the project a star! Thanks again!
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request

<p align="right">(<a href="#top">back to top</a>)</p>
<p align="right">(<a href="#readme-top">back to top</a>)</p>



Expand All @@ -203,7 +204,7 @@ Don't forget to give the project a star! Thanks again!

Distributed under the MIT License. See `LICENSE.txt` for more information.

<p align="right">(<a href="#top">back to top</a>)</p>
<p align="right">(<a href="#readme-top">back to top</a>)</p>



Expand All @@ -214,7 +215,7 @@ Your Name - [@your_twitter](https://twitter.com/your_username) - [email protected]

Project Link: [https://github.com/your_username/repo_name](https://github.com/your_username/repo_name)

<p align="right">(<a href="#top">back to top</a>)</p>
<p align="right">(<a href="#readme-top">back to top</a>)</p>



Expand All @@ -232,7 +233,7 @@ Use this space to list resources you find helpful and would like to give credit
* [Font Awesome](https://fontawesome.com)
* [React Icons](https://react-icons.github.io/react-icons/search)

<p align="right">(<a href="#top">back to top</a>)</p>
<p align="right">(<a href="#readme-top">back to top</a>)</p>



Expand Down Expand Up @@ -266,4 +267,4 @@ Use this space to list resources you find helpful and would like to give credit
[Bootstrap.com]: https://img.shields.io/badge/Bootstrap-563D7C?style=for-the-badge&logo=bootstrap&logoColor=white
[Bootstrap-url]: https://getbootstrap.com
[JQuery.com]: https://img.shields.io/badge/jQuery-0769AD?style=for-the-badge&logo=jquery&logoColor=white
[JQuery-url]: https://jquery.com
[JQuery-url]: https://jquery.com

0 comments on commit 3552467

Please sign in to comment.