A awesome repo template to kick-start your next project
Show your support!
How to use this template:
To run any of these tasks you MUST be in the Actions section
How to find the Action
How to replace all links with your own:
Edit the [repo_config.json](.github/py_repo_tools/repo_config.json) file & set the value for "REPLACE_TEXT_WITH" - to your username & repo name like the following example MyUserName/My-Repo-Name And run the Repo Generator in Actions - set "Update all links" to
checked
How to replace e-mail in Code of Conduct with your own:
Edit the [repo_config.json](.github/py_repo_tools/repo_config.json) file & set the value for "CODE_OF_CONDUCT_EMAIL" - to your e-mail address like the following example. hello_world@github.com And run the Repo Generator in Actions- set "Update Code Of Conduct Info" to
checked
How to generate Table Of Contents:
To generate tables of contents automatically use anywhere in your README.md file a comment like so <!-- toc --> <!-- tocstop --> And when running the Repo Generator in Actions - set "Generate Table Of Contents" to
checked
WARNING: Only 1 table of contents can be generated in a README - if you use more than one you WILL face problems.
How to Generate a Metrics Image:
Create a Personal Access Token & create a repo secret called "METRICS_TOKEN" & when running the Repo Generator - set "Generate Metrics Image File" to
checked
You will have an image generated that looks like this!
It will be placed in the main repo under the filename stargazers-metrics.svg
Note: if someone knows how to change this please make a pull request with the image placed to .github folder!
Shield.io Buttons:
_Repo metadata_ [](https://github.com/YOUR_GITHUB_USERNAME/Your-Repo-Name/blob/master/LICENSE) [](https://github.com/YOUR_GITHUB_USERNAME/Your-Repo-Name/issues) [](https://github.com/YOUR_GITHUB_USERNAME/Your-Repo-Name/issues?utf8=✓&q=is%3Aissue+is%3Aclosed) [](https://github.com/YOUR_GITHUB_USERNAME/Your-Repo-Name/pulls) [](https://github.com/YOUR_GITHUB_USERNAME/Your-Repo-Name/pulls?utf8=✓&q=is%3Apr+is%3Aclosed) [](https://github.com/YOUR_GITHUB_USERNAME/Your-Repo-Name/graphs/commit-activity) [](https://github.com/YOUR_GITHUB_USERNAME/Your-Repo-Name/graphs/contributors) [](https://github.com/YOUR_GITHUB_USERNAME/Your-Repo-Name/commits/master) [](https://github.com/YOUR_GITHUB_USERNAME/Your-Repo-Name/releases/) _Social buttons_ [](https://github.com/YOUR_GITHUB_USERNAME/Your-Repo-Name "Go to GitHub repo") [](https://github.com/YOUR_GITHUB_USERNAME/Your-Repo-Name) [](https://github.com/YOUR_GITHUB_USERNAME/Your-Repo-Name) _Call-to-Action buttons_ [](https://github.com/YOUR_GITHUB_USERNAME/Your-Repo-Name/generate) [](https://marketingpip.github.io/Awesome-Repo-Template/) _Documentation button_ [](/README.MD "Go to project documentation") _Custom button_
Auto Generated Table Of Contents Demo:
- [Features:](#features) - [Example and Usage](#example-and-usage) - [Contributing  ](#contributing-a-hrefhttpsgithubcommarketingpipelineawesome-repo-templategraphscontributors-githubhttpsimgshieldsiogithubcontributorsmarketingpipelineawesome-repo-template-a) - [License  ](#license-a-hreflicense-githubhttpsimgshieldsiogithublicensemarketingpipelineawesome-repo-template-a)