hoelee/Best-README-Template
1
0
Fork 0
mirror of https://github.com/othneildrew/Best-README-Template.git synced 2026-10-12 12:16:38 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Merge branch 'chore/markdown-linting' of github.com:actuarysailor/template-readme-only into actuarysailor-chore/markdown-linting

Browse Source
This commit is contained in:
Othneil Drew
2025-10-02 12:17:01 -05:00
parent 705346985e 1f79f523e8
commit cc154bf4dc
5 changed files with 217 additions and 133 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.github/ISSUE_TEMPLATE/bug-report---.md
+8 -3
View File
@@ -6,17 +6,22 @@ labels: bug
---
## Describe the bug
A clear and concise description of what the bug is.
### Steps to reproduce
Steps to reproduce the behavior.
### Expected behavior
A clear and concise description of what you expected to happen.
### Environment
- OS: [e.g. Arch Linux]
- Other details that you think may affect.
- OS: [e.g. Arch Linux]
- Other details that you think may affect.
### Additional context
Add any other context about the problem here.
Add any other context about the problem here.
.github/ISSUE_TEMPLATE/feature-request---.md
+4 -1
View File
@@ -6,10 +6,13 @@ labels: enhancement
---
## Summary
Brief explanation of the feature.
### Basic example
Include a basic example or links here.
### Motivation
Why are we doing this? What use cases does it support? What is the expected outcome?
Why are we doing this? What use cases does it support? What is the expected outcome?
.markdownlint.json
+32
View File
@@ -0,0 +1,32 @@
{
"MD013": {
"line_length": 80,
"code_blocks": false,
"tables": false,
"headings": false
},
"MD033": {
"allowed_elements": [
"a",
"div",
"img",
"h1",
"h2",
"h3",
"h4",
"h5",
"h6",
"p",
"br",
"strong",
"em",
"details",
"summary",
"ol",
"ul",
"li"
]
},
"MD041": false,
"MD034": false
}
BLANK_README.md
+74 -58
View File
@@ -1,5 +1,7 @@
<!-- Improved compatibility of back to top link: See: https://github.com/othneildrew/Best-README-Template/pull/73 -->
<!-- Improved compatibility of back to top link:
See: https://github.com/othneildrew/Best-README-Template/pull/73 -->
<a id="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
@@ -8,16 +10,16 @@
*** Thanks again! Now go create something AMAZING! :D
-->
<!-- PROJECT SHIELDS -->
<!--
*** I'm using markdown "reference style" links for readability.
*** Reference links are enclosed in brackets [ ] instead of parentheses ( ).
*** See the bottom of this document for the declaration of the reference variables
*** for contributors-url, forks-url, etc. This is an optional, concise syntax you may use.
*** for contributors-url, forks-url, etc. This is an optional, concise syntax
*** you may use.
*** https://www.markdownguide.org/basic-syntax/#reference-style-links
-->
[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
@@ -25,34 +27,40 @@
[![project_license][license-shield]][license-url]
[![LinkedIn][linkedin-shield]][linkedin-url]
<!-- PROJECT LOGO -->
<br />
<div align="center">
<a href="https://github.com/github_username/repo_name">
<img src="images/logo.png" alt="Logo" width="80" height="80">
</a>
<h3 align="center">project_title</h3>
<h3 align="center">project_title</h3>
<p align="center">
project_description
<br />
<a href="https://github.com/github_username/repo_name"><strong>Explore the docs »</strong></a>
<a href="https://github.com/github_username/repo_name">
<strong>Explore the docs »</strong>
</a>
<br />
<br />
<a href="https://github.com/github_username/repo_name">View Demo</a>
&middot;
<a href="https://github.com/github_username/repo_name/issues/new?labels=bug&template=bug-report---.md">Report Bug</a>
&middot;
<a href="https://github.com/github_username/repo_name/issues/new?labels=enhancement&template=feature-request---.md">Request Feature</a>
·
<a href="https://github.com/github_username/repo_name/issues/new?labels=bug
&template=bug-report---.md">
Report Bug
</a>
·
<a href="https://github.com/github_username/repo_name/issues/new?labels=enhancement
&template=feature-request---.md">
Request Feature
</a>
</p>
</div>
<!-- TABLE OF CONTENTS -->
<details>
<summary>Table of Contents</summary>
<ol>
@@ -78,19 +86,19 @@
</ol>
</details>
<!-- ABOUT THE PROJECT -->
## About The Project
[![Product Name Screen Shot][product-screenshot]](https://example.com)
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`, `project_license`
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`, `project_license`
<p align="right">(<a href="#readme-top">back to top</a>)</p>
### Built With
[![Next][Next.js]][Next-url]
@@ -104,38 +112,47 @@ Here's a blank template to get started. To avoid retyping too much info, do a se
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- GETTING STARTED -->
## Getting Started
This is an example of how you may give instructions on setting up your project locally.
To get a local copy up and running follow these simple example steps.
This is an example of how you may give instructions on setting up your project
locally. To get a local copy up and running follow these simple example steps.
### Prerequisites
This is an example of how to list things you need to use the software and how to install them.
* npm
This is an example of how to list things you need to use the software and how
to install them.
- npm
```sh
npm install npm@latest -g
```
### Installation
1. Get a free API Key at [https://example.com](https://example.com)
1. Get a free API Key at <https://example.com>
2. Clone the repo
```sh
git clone https://github.com/github_username/repo_name.git
```
3. Install NPM packages
```sh
npm install
```
4. Enter your API in `config.js`
```js
const API_KEY = 'ENTER YOUR API';
```
5. Change git remote url to avoid accidental pushes to base project
```sh
git remote set-url origin github_username/repo_name
git remote -v # confirm the changes
@@ -143,40 +160,42 @@ This is an example of how to list things you need to use the software and how to
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- USAGE EXAMPLES -->
## Usage
Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.
Use this space to show useful examples of how a project can be used. Additional
screenshots, code examples and demos work well in this space. You may also link
to more resources.
_For more examples, please refer to the [Documentation](https://example.com)_
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- ROADMAP -->
## Roadmap
- [ ] Feature 1
- [ ] Feature 2
- [ ] Feature 3
- [ ] Nested Feature
- [ ] Nested Feature
See the [open issues](https://github.com/github_username/repo_name/issues) for a full list of proposed features (and known issues).
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="#readme-top">back to top</a>)</p>
<!-- CONTRIBUTING -->
## Contributing
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
Contributions are what make the open source community such an amazing place to
learn, inspire, and create. Any contributions you make are **greatly appreciated**.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
Don't forget to give the project a star! Thanks again!
If you have a suggestion that would make this better, please fork the repo and
create a pull request. You can also simply open an issue with the tag
"enhancement". Don't forget to give the project a star! Thanks again!
1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
@@ -186,49 +205,45 @@ Don't forget to give the project a star! Thanks again!
<p align="right">(<a href="#readme-top">back to top</a>)</p>
### Top contributors:
### Top contributors
<a href="https://github.com/github_username/repo_name/graphs/contributors">
<img src="https://contrib.rocks/image?repo=github_username/repo_name" alt="contrib.rocks image" />
<img src="https://contrib.rocks/image?repo=github_username/repo_name"
alt="contrib.rocks image" />
</a>
<!-- LICENSE -->
## License
This project is dedicated to the public domain under the CC0 1.0 Universal license. See `LICENSE.txt` for more information.
**IMPORTANT**: Update the license to match your project.
Distributed under the project_license. See `LICENSE.txt` for more information.
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- CONTACT -->
## Contact
Your Name - [@twitter_handle](https://twitter.com/twitter_handle) - email@email_client.com
Project Link: [https://github.com/github_username/repo_name](https://github.com/github_username/repo_name)
Your Name
𝕏[@your_twitter](https://twitter.com/your_username)
📧[[email protected]](mailto:[email protected])
Project Link: <https://github.com/your_username/repo_name>
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- ACKNOWLEDGMENTS -->
## Acknowledgments
* []()
* []()
* []()
- []()
- []()
- []()
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- MARKDOWN LINKS & IMAGES -->
<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
[contributors-shield]: https://img.shields.io/github/contributors/github_username/repo_name.svg?style=for-the-badge
[contributors-url]: https://github.com/github_username/repo_name/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/github_username/repo_name.svg?style=for-the-badge
@@ -242,6 +257,7 @@ Project Link: [https://github.com/github_username/repo_name](https://github.com/
[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555
[linkedin-url]: https://linkedin.com/in/linkedin_username
[product-screenshot]: images/screenshot.png
<!-- Shields.io badges. You can a comprehensive list with many more badges at: https://github.com/inttter/md-badges -->
[Next.js]: https://img.shields.io/badge/next.js-000000?style=for-the-badge&logo=nextdotjs&logoColor=white
[Next-url]: https://nextjs.org/
@@ -258,4 +274,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
README.md
+99 -71
View File
@@ -1,5 +1,7 @@
<!-- Improved compatibility of back to top link: See: https://github.com/othneildrew/Best-README-Template/pull/73 -->
<!-- Improved compatibility of back to top link:
See: https://github.com/othneildrew/Best-README-Template/pull/73 -->
<a id="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
@@ -8,27 +10,25 @@
*** Thanks again! Now go create something AMAZING! :D
-->
<!-- PROJECT SHIELDS -->
<!--
*** I'm using markdown "reference style" links for readability.
*** Reference links are enclosed in brackets [ ] instead of parentheses ( ).
*** See the bottom of this document for the declaration of the reference variables
*** for contributors-url, forks-url, etc. This is an optional, concise syntax you may use.
*** for contributors-url, forks-url, etc. This is an optional, concise syntax
*** you may use.
*** https://www.markdownguide.org/basic-syntax/#reference-style-links
-->
[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![Unlicense License][license-shield]][license-url]
[![CC0 1.0 Universal][license-shield]][license-url]
[![LinkedIn][linkedin-shield]][linkedin-url]
<!-- PROJECT LOGO -->
<br />
<div align="center">
<a href="https://github.com/othneildrew/Best-README-Template">
<img src="images/logo.png" alt="Logo" width="80" height="80">
@@ -39,20 +39,25 @@
<p align="center">
An awesome README template to jumpstart your projects!
<br />
<a href="https://github.com/othneildrew/Best-README-Template"><strong>Explore the docs »</strong></a>
<a href="https://github.com/othneildrew/Best-README-Template">
<strong>Explore the docs »</strong>
</a>
<br />
<br />
<a href="https://github.com/othneildrew/Best-README-Template">View Demo</a>
&middot;
<a href="https://github.com/othneildrew/Best-README-Template/issues/new?labels=bug&template=bug-report---.md">Report Bug</a>
&middot;
<a href="https://github.com/othneildrew/Best-README-Template/issues/new?labels=enhancement&template=feature-request---.md">Request Feature</a>
·
<a href="https://github.com/othneildrew/Best-README-Template/issues/new?labels=bug
&template=bug-report---.md">Report Bug</a>
·
<a href="https://github.com/othneildrew/Best-README-Template/issues/new?labels=enhancement
&template=feature-request---.md">
Request Feature
</a>
</p>
</div>
<!-- TABLE OF CONTENTS -->
<details>
<summary>Table of Contents</summary>
<ol>
@@ -78,33 +83,42 @@
</ol>
</details>
<!-- ABOUT THE PROJECT -->
## About The Project
[![Product Name Screen Shot][product-screenshot]](https://example.com)
There are many great README templates available on GitHub; however, I didn't find one that really suited my needs so I created this enhanced one. I want to create a README template so amazing that it'll be the last one you ever need -- I think this is it.
There are many great README templates available on GitHub; however, I didn't
find one that really suited my needs so I created this enhanced one. I want to
create a README template so amazing that it'll be the last one you ever need --
I think this is it.
Here's why:
* Your time should be focused on creating something amazing. A project that solves a problem and helps others
* You shouldn't be doing the same tasks over and over like creating a README from scratch
* You should implement DRY principles to the rest of your life :smile:
Of course, no one template will serve all projects since your needs may be different. So I'll be adding more in the near future. You may also suggest changes by forking this repo and creating a pull request or opening an issue. Thanks to all the people have contributed to expanding this template!
- Your time should be focused on creating something amazing. A project that
solves a problem and helps others
- You shouldn't be doing the same tasks over and over like creating a README
from scratch
- You should implement DRY principles to the rest of your life :smile:
Of course, no one template will serve all projects since your needs may be
different. So I'll be adding more in the near future. You may also suggest
changes by forking this repo and creating a pull request or opening an issue.
Thanks to all the people have contributed to expanding this template!
Use the `BLANK_README.md` to get started.
**Update the license to match your intended project license. THIS repo is fully dedicated to the public domain, but your project probably isn't.**
**Update the license to match your intended project license. THIS repo is fully dedicated to the public domain, but your
project probably isn't.**
<p align="right">(<a href="#readme-top">back to top</a>)</p>
### Built With
This section should list any major frameworks/libraries used to bootstrap your project. Leave any add-ons/plugins for the acknowledgements section. Here are a few examples.
This section should list any major frameworks/libraries used to bootstrap your
project. Leave any add-ons/plugins for the acknowledgements section. Here are a
few examples.
[![Next][Next.js]][Next-url]
[![React][React.js]][React-url]
@@ -117,40 +131,51 @@ This section should list any major frameworks/libraries used to bootstrap your p
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- GETTING STARTED -->
## Getting Started
This is an example of how you may give instructions on setting up your project locally.
To get a local copy up and running follow these simple example steps.
This is an example of how you may give instructions on setting up your project
locally. To get a local copy up and running follow these simple example steps.
### Prerequisites
This is an example of how to list things you need to use the software and how to install them.
* npm
This is an example of how to list things you need to use the software and how
to install them.
- npm
```sh
npm install npm@latest -g
```
### Installation
_Below is an example of how you can instruct your audience on installing and setting up your app. This template doesn't rely on any external dependencies or services._
_Below is an example of how you can instruct your audience on installing and
setting up your app. This template doesn't rely on any external dependencies
or services._
1. Get a free API Key at [https://example.com](https://example.com)
1. Get a free API Key at <https://example.com>
2. Clone the repo
```sh
git clone https://github.com/github_username/repo_name.git
```
3. Install NPM packages
```sh
npm install
```
4. Enter your API in `config.js`
```js
const API_KEY = 'ENTER YOUR API';
```
5. Change git remote url to avoid accidental pushes to base project
```sh
git remote set-url origin github_username/repo_name
git remote -v # confirm the changes
@@ -158,20 +183,20 @@ _Below is an example of how you can instruct your audience on installing and set
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- USAGE EXAMPLES -->
## Usage
Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.
Use this space to show useful examples of how a project can be used. Additional
screenshots, code examples and demos work well in this space. You may also link
to more resources.
_For more examples, please refer to the [Documentation](https://example.com)_
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- ROADMAP -->
## Roadmap
- [x] Add Changelog
@@ -179,22 +204,24 @@ _For more examples, please refer to the [Documentation](https://example.com)_
- [ ] Add Additional Templates w/ Examples
- [ ] Add "components" document to easily copy & paste sections of the readme
- [ ] Multi-language Support
- [ ] Chinese
- [ ] Spanish
- [ ] Chinese
- [ ] Spanish
See the [open issues](https://github.com/othneildrew/Best-README-Template/issues) for a full list of proposed features (and known issues).
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="#readme-top">back to top</a>)</p>
<!-- CONTRIBUTING -->
## Contributing
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
Contributions are what make the open source community such an amazing place to
learn, inspire, and create. Any contributions you make are **greatly appreciated**.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
Don't forget to give the project a star! Thanks again!
If you have a suggestion that would make this better, please fork the repo and
create a pull request. You can also simply open an issue with the tag
"enhancement". Don't forget to give the project a star! Thanks again!
1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
@@ -202,58 +229,59 @@ 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
### Top contributors:
### Top contributors
<a href="https://github.com/othneildrew/Best-README-Template/graphs/contributors">
<img src="https://contrib.rocks/image?repo=othneildrew/Best-README-Template" alt="contrib.rocks image" />
<img
src="https://contrib.rocks/image?repo=othneildrew/Best-README-Template"
alt="contrib.rocks image"
/>
</a>
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- LICENSE -->
## License
This project is dedicated to the public domain under the CC0 1.0 Universal license. See `LICENSE.txt` for more information.
**IMPORTANT**: Update the license to match your project.
**IMPORTANT**: Update the license to match your intended project license.
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- CONTACT -->
## Contact
Your Name - [@your_twitter](https://twitter.com/your_username) - email@example.com
Project Link: [https://github.com/your_username/repo_name](https://github.com/your_username/repo_name)
Your Name
𝕏[@your_twitter](https://twitter.com/your_username)
📧[[email protected]](mailto:[email protected])
Project Link: <https://github.com/your_username/repo_name>
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- ACKNOWLEDGMENTS -->
## Acknowledgments
Use this space to list resources you find helpful and would like to give credit to. I've included a few of my favorites to kick things off!
Use this space to list resources you find helpful and would like to give credit
to. I've included a few of my favorites to kick things off!
* [Choose an Open Source License](https://choosealicense.com)
* [GitHub Emoji Cheat Sheet](https://www.webpagefx.com/tools/emoji-cheat-sheet)
* [Malven's Flexbox Cheatsheet](https://flexbox.malven.co/)
* [Malven's Grid Cheatsheet](https://grid.malven.co/)
* [Img Shields](https://shields.io)
* [GitHub Pages](https://pages.github.com)
* [Font Awesome](https://fontawesome.com)
* [React Icons](https://react-icons.github.io/react-icons/search)
- [Choose an Open Source License](https://choosealicense.com)
- [GitHub Emoji Cheat Sheet](https://www.webpagefx.com/tools/emoji-cheat-sheet)
- [Malven's Flexbox Cheatsheet](https://flexbox.malven.co/)
- [Malven's Grid Cheatsheet](https://grid.malven.co/)
- [Img Shields](https://shields.io)
- [GitHub Pages](https://pages.github.com)
- [Font Awesome](https://fontawesome.com)
- [React Icons](https://react-icons.github.io/react-icons/search)
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- MARKDOWN LINKS & IMAGES -->
<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
[contributors-shield]: https://img.shields.io/github/contributors/othneildrew/Best-README-Template.svg?style=for-the-badge
[contributors-url]: https://github.com/othneildrew/Best-README-Template/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/othneildrew/Best-README-Template.svg?style=for-the-badge
@@ -282,4 +310,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