├── .github ├── issue_label_bot.yaml ├── py_repo_tools │ ├── repo_config.json │ ├── shell_scripts │ │ └── github_downloader.sh │ ├── replace_repo_links.py │ ├── replace_security_policy_email.py │ ├── replace_code_of_conduct_info.py │ └── generate_index_file.py ├── CODEOWNERS ├── TO_DO.md ├── CHANGE_LOG.md ├── ISSUE_TEMPLATE │ ├── feature_request.yaml │ └── bug_report.yaml ├── CONTRIBUTING.md ├── config.yml ├── pull_request_template.md ├── SECURITY.md ├── workflows │ └── Repo-Generator.yaml ├── CODE_OF_CONDUCT.md └── settings.yml ├── LICENSE ├── index.html ├── README.md └── stargazers-metrics.svg /.github/issue_label_bot.yaml: -------------------------------------------------------------------------------- 1 | label-alias: 2 | bug: 'Type: Bug' 3 | feature_request: 'Type: Feature' 4 | question: 'Type: Question' 5 | -------------------------------------------------------------------------------- /.github/py_repo_tools/repo_config.json: -------------------------------------------------------------------------------- 1 | {"Text_To_Replace": "MarketingPipeline/Awesome-Repo-Template", "Text_To_Replace_With": "YOUR_GITHUB_USERNAME/Your-Repo-Name", "EMAIL" : "test@example.com"} 2 | -------------------------------------------------------------------------------- /.github/CODEOWNERS: -------------------------------------------------------------------------------- 1 | # These owners will be the default owners for everything in 2 | # the repo. Unless a later match takes precedence, 3 | # @MarketingPip will be requested for 4 | # review when someone opens a pull request. 5 | # if you want to add more owners just write it after the demo user @OctoCat 6 | * @MarketingPip 7 | -------------------------------------------------------------------------------- /.github/TO_DO.md: -------------------------------------------------------------------------------- 1 | # To-Do 2 | 3 | ## Tasks (Sorted by Priority) 4 | 5 | 6 | #### High 7 | 8 | - [ ] Demo Task 9 | - [ ] Demo Task 10 | - [ ] Demo Task 11 | - [ ] Demo Sub-Task 12 | - [ ] Demo Sub-Task 13 | 14 | 15 | #### Medium 16 | 17 | - [ ] Demo Task 18 | - [ ] Demo Task 19 | - [ ] Demo Task 20 | - [ ] Demo Sub-Task 21 | - [ ] Demo Sub-Task 22 | 23 | #### Low 24 | 25 | - [ ] Demo Task 26 | - [ ] Demo Task 27 | - [ ] Demo Task 28 | - [ ] Demo Sub-Task 29 | - [ ] Demo Sub-Task 30 | -------------------------------------------------------------------------------- /.github/CHANGE_LOG.md: -------------------------------------------------------------------------------- 1 | # Changelog 2 | 3 | All notable changes to this project will be documented in this file. 4 | 5 | ## [Unreleased] 6 | 7 | 11 | 12 | Upcoming changes. 13 | 14 | ### Added 15 | 16 | ### Changed 17 | 18 | ### Removed 19 | 20 | ## [0.0.1] - YYYY-MM-DD 21 | 22 | Initial Release. 23 | 24 | ### Added 25 | 26 | - What was added. 27 | 28 | 29 | 33 | [Unreleased]: / 34 | [0.0.1]: /v0.0.1 35 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/feature_request.yaml: -------------------------------------------------------------------------------- 1 | name: Feature request 2 | description: Suggest an feature / idea for this project 3 | title: "[Feature Request / Suggestion]: " 4 | labels: ["enhancement"] 5 | body: 6 | - type: markdown 7 | attributes: 8 | value: | 9 | We appreciate your feedback on how to improve this project. Please be sure to include as much details & any resources if possible! 10 | - type: textarea 11 | id: Suggestion 12 | attributes: 13 | label: Suggestion / Feature Request 14 | description: Describe the feature(s) you would like to see added. 15 | placeholder: Tell us your suggestion 16 | value: "Your suggestion here" 17 | validations: 18 | required: true 19 | 20 | -------------------------------------------------------------------------------- /.github/py_repo_tools/shell_scripts/github_downloader.sh: -------------------------------------------------------------------------------- 1 | 2 | #!/bin/bash 3 | ##################################################### 4 | # Download Specific folders from Github using SVN 5 | # 6 | # Author: Declan Cook 7 | # Licence: MIT 8 | ##################################################### 9 | GHDOMAIN="https://github.com/" 10 | IN=$1 11 | IN=${IN##$GHDOMAIN} 12 | BRANCH="trunk" 13 | FOLDER="" 14 | IFS="/" read -a SECT <<< "$IN" 15 | 16 | if [[ "${SECT[3]}" != "master" ]]; then 17 | BRANCH=${SECT[3]} 18 | fi 19 | for index in "${!SECT[@]}"; do 20 | if [ $index -gt 3 ]; then 21 | FOLDER=$FOLDER/${SECT[index]} 22 | fi 23 | done 24 | 25 | # DOMAIN/USER/PROJECT//FOLDER 26 | echo Exporting $GHDOMAIN${SECT[0]}/${SECT[1]}/$BRANCH$FOLDER 27 | svn --force export $GHDOMAIN${SECT[0]}/${SECT[1]}/$BRANCH$FOLDER ./ 28 | -------------------------------------------------------------------------------- /.github/CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | # Contributing 2 | 3 | There are a lot of different ways to contribute to this project. See below for 4 | everything you can do and the processes to follow for each contribution method. 5 | Note that no matter how you contribute, your participation is governed by our 6 | [Code of Conduct](CODE_OF_CONDUCT.md). 7 | 8 | ## Make changes to the code or docs 9 | 10 | Fork the project, make a change, and send a pull request! 11 | 12 | Make sure you read and follow the instructions in the [pull request template](.github/pull_request_template.md). And note 13 | that all participation in this project (including code submissions) is 14 | governed by our [Code of Conduct](CODE_OF_CONDUCT.md). 15 | 16 | ## Submit bug reports or feature requests 17 | 18 | Just use the GitHub issue tracker to submit your bug reports and feature 19 | requests. 20 | -------------------------------------------------------------------------------- /.github/config.yml: -------------------------------------------------------------------------------- 1 | # Configuration for new-issue-welcome - https://github.com/behaviorbot/new-issue-welcome 2 | 3 | # Comment to be posted to on first time issues 4 | newIssueWelcomeComment: > 5 | Thanks for opening your first issue! Reports like these help improve the project! 6 | 7 | # Configuration for new-pr-welcome - https://github.com/behaviorbot/new-pr-welcome 8 | 9 | # Comment to be posted to on PRs from first time contributors in your repository 10 | newPRWelcomeComment: > 11 | Thanks for opening this pull request! 12 | 13 | # Configuration for first-pr-merge - https://github.com/behaviorbot/first-pr-merge 14 | 15 | # Comment to be posted to on pull requests merged by a first time user 16 | firstPRMergeComment: > 17 | Congrats on merging your first pull request! 18 | 19 | # The keyword to find for Todo Bot issue 20 | todo: 21 | keyword: '@todo' 22 | -------------------------------------------------------------------------------- /.github/py_repo_tools/replace_repo_links.py: -------------------------------------------------------------------------------- 1 | # Python program to read 2 | # json file 3 | 4 | 5 | import json 6 | 7 | # Opening JSON file 8 | f = open('.github/py_repo_tools/repo_config.json') 9 | 10 | # returns JSON object as 11 | # a dictionary 12 | config = json.load(f) 13 | 14 | 15 | # Define the filename here you want to replace content in 16 | FileName = "README.md" 17 | 18 | Text_To_Replace = config['Text_To_Replace'] 19 | 20 | Text_To_Replace_With = config['Text_To_Replace_With'] 21 | 22 | # Closing file 23 | f.close() 24 | 25 | 26 | # Open the File 27 | with open(FileName, 'r') as f: 28 | # Read the file contents 29 | contents = f.read() 30 | # Replace the file contents 31 | contents = contents.replace(Text_To_Replace, Text_To_Replace_With) 32 | 33 | # Write the file out 34 | with open(FileName, 'w') as f: 35 | # Write the updated contents 36 | f.write(contents) 37 | -------------------------------------------------------------------------------- /.github/py_repo_tools/replace_security_policy_email.py: -------------------------------------------------------------------------------- 1 | 2 | import json 3 | 4 | # Opening JSON file 5 | f = open('.github/py_repo_tools/repo_config.json') 6 | 7 | # returns JSON object as 8 | # a dictionary 9 | config = json.load(f) 10 | 11 | 12 | # Define the filename here you want to replace content in 13 | FileName = ".github/SECURITY.md" 14 | 15 | # Replace with string 16 | Text_To_Replace = "example@hello.com" 17 | 18 | # Replace with JSON value 19 | Text_To_Replace_With = config['EMAIL'] 20 | 21 | # Closing file 22 | f.close() 23 | 24 | 25 | # Open the File 26 | with open(FileName, 'r') as f: 27 | # Read the file contents 28 | contents = f.read() 29 | # Replace the file contents 30 | contents = contents.replace(Text_To_Replace, Text_To_Replace_With) 31 | 32 | # Write the file out 33 | with open(FileName, 'w') as f: 34 | # Write the updated contents 35 | f.write(contents) 36 | -------------------------------------------------------------------------------- /.github/py_repo_tools/replace_code_of_conduct_info.py: -------------------------------------------------------------------------------- 1 | 2 | import json 3 | 4 | # Opening JSON file 5 | f = open('.github/py_repo_tools/repo_config.json') 6 | 7 | # returns JSON object as 8 | # a dictionary 9 | config = json.load(f) 10 | 11 | 12 | # Define the filename here you want to replace content in 13 | FileName = ".github/CODE_OF_CONDUCT.md" 14 | 15 | # Replace with string 16 | Text_To_Replace = "example@hello.com" 17 | 18 | # Replace with JSON value 19 | Text_To_Replace_With = config['EMAIL'] 20 | 21 | # Closing file 22 | f.close() 23 | 24 | 25 | # Open the File 26 | with open(FileName, 'r') as f: 27 | # Read the file contents 28 | contents = f.read() 29 | # Replace the file contents 30 | contents = contents.replace(Text_To_Replace, Text_To_Replace_With) 31 | 32 | # Write the file out 33 | with open(FileName, 'w') as f: 34 | # Write the updated contents 35 | f.write(contents) 36 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | MIT License 2 | 3 | Copyright (c) 2022 Marketing Pipeline 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 21 | SOFTWARE. 22 | -------------------------------------------------------------------------------- /.github/pull_request_template.md: -------------------------------------------------------------------------------- 1 | ## Proposed changes 2 | 3 | Describe the big picture of your changes here to communicate to the maintainers why we should accept this pull request. If it fixes a bug or resolves a feature request, be sure to link to that issue. 4 | 5 | ## Types of changes 6 | 7 | What types of changes does your code introduce to this project? 8 | _Put an `x` in the boxes that apply_ 9 | 10 | - [ ] Bugfix (non-breaking change which fixes an issue) 11 | - [ ] New feature (non-breaking change which adds functionality) 12 | - [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) 13 | - [ ] Documentation Update (if none of the other choices apply) 14 | 15 | ## Checklist 16 | 17 | _Put an `x` in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your code._ 18 | 19 | - [ ] I have read the CONTRIBUTING.md 20 | - [ ] I have added tests that prove my fix is effective or that my feature works 21 | - [ ] I have added necessary documentation (if appropriate) 22 | 23 | ## Further comments 24 | 25 | If this is a relatively large or complex change, kick off the discussion by explaining why you chose the solution you did and what alternatives you considered, etc... 26 | -------------------------------------------------------------------------------- /.github/SECURITY.md: -------------------------------------------------------------------------------- 1 | # Security Policy 2 | 3 | ## Supported Versions 4 | 5 | | Version | Supported | 6 | | ------- | ------------------ | 7 | | 5.1.x | :white_check_mark: | 8 | | 5.0.x | :x: | 9 | | 4.0.x | :white_check_mark: | 10 | | < 4.0 | :x: | 11 | 12 | ## Reporting a Vulnerability 13 | 14 | If you have identified a security vulnerability in system or product please email `example@hello.com` with your findings. We strongly recommend using our `PGP key` to prevent this information from falling into the wrong hands. 15 | 16 | ### Disclosure Policy 17 | 18 | Upon receipt of a security report the following steps will be taken: 19 | 20 | - Acknowledge your report within 48 hours, and provide a further more detailed update within 48 hours. 21 | - Confirm the problem and determine the affected versions 22 | - Keep you informed of the progress towards resolving the problem and notify you when the vulnerability has been fixed. 23 | - Audit code to find any potential similar problems. 24 | - Prepare fixes for all releases still under maintenance. These fixes will be released as fast as possible. 25 | - Handle your report with strict confidentiality, and not pass on your personal details to third parties without your permission. 26 | 27 | Whilst the issue is under investigation 28 | 29 | - **Do** provide as much information as possible. 30 | - **Do not** exploit of the vulnerability or problem you have discovered. 31 | - **Do not** reveal the problem to others until it has been resolved. 32 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/bug_report.yaml: -------------------------------------------------------------------------------- 1 | name: Bug Report 2 | description: File a bug report 3 | title: "[Bug]: " 4 | labels: ["bug", "triage"] 5 | assignees: 6 | - octocat 7 | body: 8 | - type: markdown 9 | attributes: 10 | value: | 11 | Thanks for taking the time to fill out this bug report! 12 | - type: input 13 | id: contact 14 | attributes: 15 | label: Contact Details 16 | description: How can we get in touch with you if we need more info? 17 | placeholder: ex. email@example.com 18 | validations: 19 | required: false 20 | - type: textarea 21 | id: what-happened 22 | attributes: 23 | label: What happened? 24 | description: Describe the issue here. 25 | placeholder: Tell us what you see! 26 | value: "A bug happened!" 27 | validations: 28 | required: true 29 | - type: dropdown 30 | id: browsers 31 | attributes: 32 | label: What type of browser are you seeing the problem on? 33 | multiple: true 34 | options: 35 | - Firefox 36 | - Chrome 37 | - Safari 38 | - Microsoft Edge 39 | validations: 40 | required: true 41 | 42 | - type: dropdown 43 | id: operating-systems 44 | attributes: 45 | label: What type of Operating System are you seeing the problem on? 46 | multiple: true 47 | options: 48 | - Linux 49 | - Windows 50 | - Mac 51 | - Other 52 | validations: 53 | required: true 54 | 55 | 56 | - type: textarea 57 | id: logs 58 | attributes: 59 | label: Code to produce this issue. 60 | description: Please copy and paste any relevant code to re-produce this issue. And the version of the browser you are using. 61 | render: shell 62 | -------------------------------------------------------------------------------- /.github/py_repo_tools/generate_index_file.py: -------------------------------------------------------------------------------- 1 | #! /usr/bin/env python 2 | # -*- coding: utf-8 -*- 3 | 4 | 5 | import sys 6 | import os 7 | import codecs 8 | import urllib.request, json 9 | 10 | 11 | 12 | 13 | 14 | API_URL = os.environ['INPUT_STORE'] 15 | 16 | 17 | with urllib.request.urlopen(f"{API_URL}") as url: 18 | data = json.loads(url.read().decode()) 19 | SiteDescription = data['description'] 20 | SiteTitle = data['name'] 21 | Author = data['owner']['login'] 22 | 23 | 24 | 25 | 26 | # README File Path 27 | input_file = "README.md" 28 | input_file_contents = None 29 | 30 | # Open our README file 31 | try: 32 | with open(input_file, 'r') as f: 33 | input_file_contents = f.read() 34 | 35 | except IOError: 36 | sys.exit('README.md file does not exist, or has no content. Exiting') 37 | 38 | 39 | output_file = "index.html" 40 | 41 | # Write out the Index.HTML file 42 | try: 43 | with codecs.open(output_file, 'w', encoding='utf-8') as f: 44 | f.write(f"""{SiteTitle} 45 | 46 | 47 | 48 | 49 | 50 | 51 | 52 | 53 | 54 | 55 | 56 | 57 | 58 | 59 | 60 | 61 | 62 | 63 | 64 | 65 | 66 | 67 | """ + """ 68 | 69 | 70 | 71 | """ + 72 | 73 | input_file_contents + """ 74 | 75 | 76 | 77 | """) 78 | except IOError: 79 | sys.exit(u'Unable to write to file: {0}'.format(output_file)) 80 | -------------------------------------------------------------------------------- /.github/workflows/Repo-Generator.yaml: -------------------------------------------------------------------------------- 1 | name: Repo Generator 2 | 3 | on: 4 | workflow_dispatch: 5 | inputs: 6 | Replace_Links_In_Markdown: 7 | description: 'Update all links' 8 | type: boolean 9 | required: false 10 | Update_Code_Of_Conduct_EMAIL: 11 | description: 'Update Code Of Conduct Email' 12 | type: boolean 13 | required: false 14 | Update_Security_Policy_EMAIL: 15 | description: 'Update Security Policy Email' 16 | type: boolean 17 | required: false 18 | Compress_Images: 19 | description: 'Compress / Optimize Images' 20 | type: boolean 21 | required: false 22 | Generate_Table_Of_Contents: 23 | description: 'Generate Table Of Contents' 24 | type: boolean 25 | required: false 26 | Generate_Metrics_File: 27 | description: 'Generate Metrics Image File' 28 | type: boolean 29 | required: false 30 | Generate_Index_File: 31 | description: 'Generate Index File' 32 | type: boolean 33 | required: false 34 | Download_Files_Or_Folder: 35 | description: 'Download a file or folder from a GitHub Repo' 36 | required: False 37 | default: '' 38 | 39 | jobs: 40 | Repo_Builder: 41 | name: Repo Template Builder 42 | runs-on: ubuntu-20.04 43 | steps: 44 | - uses: actions/checkout@v2 45 | ### Update links in README file 46 | - name: Updating links in README content 47 | if: ${{ github.event.inputs.Replace_Links_In_Markdown == 'true' }} 48 | run: | 49 | sudo apt-get install python3 50 | python3 .github/py_repo_tools/replace_repo_links.py 51 | 52 | 53 | ### Metric Images 54 | 55 | - name: Generating Metrics Image 56 | if: ${{ github.event.inputs.Generate_Metrics_File == 'true' }} 57 | uses: lowlighter/metrics@v3.24 58 | with: 59 | filename: stargazers-metrics.svg 60 | filepath: /.github/ 61 | plugin_stargazers_charts_type: chartist 62 | token: ${{ secrets.METRICS_TOKEN }} 63 | 64 | 65 | 66 | base: "" 67 | 68 | config_octicon: yes 69 | 70 | plugin_stargazers: yes 71 | plugin_contributors: yes 72 | 73 | 74 | ## - name: Move Metrics Image 75 | 76 | # if: ${{ github.event.inputs.Generate_Metrics_File == 'true' }} 77 | 78 | # run: | 79 | # git mv -f ~/work/${{ github.event.repository.name }}/${{ github.event.repository.name }}/metrics.plugin.stargazers.svg ~/work/${{ github.event.repository.name }}/${{ github.event.repository.name }}/.github 80 | 81 | 82 | ### Table Of Contents 83 | - name: Generating Table Of Contents 84 | if: ${{ github.event.inputs.Generate_Table_Of_Contents == 'true' }} 85 | run: | 86 | npx markdown-toc-gen update README.md 87 | 88 | 89 | ### Generate Index File 90 | - name: Generating Index File 91 | if: ${{ github.event.inputs.Generate_Index_File == 'true' }} 92 | run: | 93 | sudo apt-get install python3 94 | INPUT_STORE=${{ github.event.repository.url }} python3 .github/py_repo_tools/generate_index_file.py 95 | 96 | 97 | 98 | ### Optimize / Compress Image 99 | - name: Optimizing Images 100 | if: ${{ github.event.inputs.Compress_Images == 'true' }} 101 | run: | 102 | sudo apt-get install python3 python3-pip 103 | pip3 install pillow optimize-images 104 | optimize-images ./ 105 | ### Replace COC E-mail 106 | - name: Updating Code Of Conduct E-Mail 107 | if: ${{ github.event.inputs.Update_Code_Of_Conduct_EMAIL == 'true' }} 108 | run: | 109 | sudo apt-get install python3 110 | python3 .github/py_repo_tools/replace_code_of_conduct_info.py 111 | 112 | ### Replace Security Policy E-mail 113 | - name: Updating Security Policy E-Mail 114 | if: ${{ github.event.inputs.Update_Security_Policy_EMAIL == 'true' }} 115 | run: | 116 | sudo apt-get install python3 117 | python3 .github/py_repo_tools/replace_security_policy_email.py 118 | 119 | 120 | ### Download a file or folder from a GitHub repo 121 | - name: Downloading file / folder from GitHub Repo 122 | if: ${{ github.event.inputs.Download_Files_Or_Folder != ''}} 123 | run: | 124 | chmod +x .github/py_repo_tools/shell_scripts/github_downloader.sh 125 | .github/py_repo_tools/shell_scripts/github_downloader.sh ${{ github.event.inputs.Download_Files_Or_Folder}} 126 | 127 | 128 | 129 | ### Commit updates (if any) 130 | - name: Commiting updates 131 | run: | 132 | git config --global user.name "github-actions[bot]" 133 | git config --global user.email "41898282+github-actions[bot]@users.noreply.github.com" 134 | git add -A 135 | git commit -m "Updated Content" 136 | git push 137 | -------------------------------------------------------------------------------- /.github/CODE_OF_CONDUCT.md: -------------------------------------------------------------------------------- 1 | # Contributor Covenant Code of Conduct 2 | 3 | ## Our Pledge 4 | 5 | We as members, contributors, and leaders pledge to make participation in our 6 | community a harassment-free experience for everyone, regardless of age, body 7 | size, visible or invisible disability, ethnicity, sex characteristics, gender 8 | identity and expression, level of experience, education, socio-economic status, 9 | nationality, personal appearance, race, religion, or sexual identity 10 | and orientation. 11 | 12 | We pledge to act and interact in ways that contribute to an open, welcoming, 13 | diverse, inclusive, and healthy community. 14 | 15 | ## Our Standards 16 | 17 | Examples of behavior that contributes to a positive environment for our 18 | community include: 19 | 20 | * Demonstrating empathy and kindness toward other people 21 | * Being respectful of differing opinions, viewpoints, and experiences 22 | * Giving and gracefully accepting constructive feedback 23 | * Accepting responsibility and apologizing to those affected by our mistakes, 24 | and learning from the experience 25 | * Focusing on what is best not just for us as individuals, but for the 26 | overall community 27 | 28 | Examples of unacceptable behavior include: 29 | 30 | * The use of sexualized language or imagery, and sexual attention or 31 | advances of any kind 32 | * Trolling, insulting or derogatory comments, and personal or political attacks 33 | * Public or private harassment 34 | * Publishing others' private information, such as a physical or email 35 | address, without their explicit permission 36 | * Other conduct which could reasonably be considered inappropriate in a 37 | professional setting 38 | 39 | ## Enforcement Responsibilities 40 | 41 | Community leaders are responsible for clarifying and enforcing our standards of 42 | acceptable behavior and will take appropriate and fair corrective action in 43 | response to any behavior that they deem inappropriate, threatening, offensive, 44 | or harmful. 45 | 46 | Community leaders have the right and responsibility to remove, edit, or reject 47 | comments, commits, code, wiki edits, issues, and other contributions that are 48 | not aligned to this Code of Conduct, and will communicate reasons for moderation 49 | decisions when appropriate. 50 | 51 | ## Scope 52 | 53 | This Code of Conduct applies within all community spaces, and also applies when 54 | an individual is officially representing the community in public spaces. 55 | Examples of representing our community include using an official e-mail address, 56 | posting via an official social media account, or acting as an appointed 57 | representative at an online or offline event. 58 | 59 | ## Enforcement 60 | 61 | Instances of abusive, harassing, or otherwise unacceptable behavior may be 62 | reported to the community leaders responsible for enforcement at 63 | the following e-mail address example@hello.com. 64 | All complaints will be reviewed and investigated promptly and fairly. 65 | 66 | All community leaders are obligated to respect the privacy and security of the 67 | reporter of any incident. 68 | 69 | ## Enforcement Guidelines 70 | 71 | Community leaders will follow these Community Impact Guidelines in determining 72 | the consequences for any action they deem in violation of this Code of Conduct: 73 | 74 | ### 1. Correction 75 | 76 | **Community Impact**: Use of inappropriate language or other behavior deemed 77 | unprofessional or unwelcome in the community. 78 | 79 | **Consequence**: A private, written warning from community leaders, providing 80 | clarity around the nature of the violation and an explanation of why the 81 | behavior was inappropriate. A public apology may be requested. 82 | 83 | ### 2. Warning 84 | 85 | **Community Impact**: A violation through a single incident or series 86 | of actions. 87 | 88 | **Consequence**: A warning with consequences for continued behavior. No 89 | interaction with the people involved, including unsolicited interaction with 90 | those enforcing the Code of Conduct, for a specified period of time. This 91 | includes avoiding interactions in community spaces as well as external channels 92 | like social media. Violating these terms may lead to a temporary or 93 | permanent ban. 94 | 95 | ### 3. Temporary Ban 96 | 97 | **Community Impact**: A serious violation of community standards, including 98 | sustained inappropriate behavior. 99 | 100 | **Consequence**: A temporary ban from any sort of interaction or public 101 | communication with the community for a specified period of time. No public or 102 | private interaction with the people involved, including unsolicited interaction 103 | with those enforcing the Code of Conduct, is allowed during this period. 104 | Violating these terms may lead to a permanent ban. 105 | 106 | ### 4. Permanent Ban 107 | 108 | **Community Impact**: Demonstrating a pattern of violation of community 109 | standards, including sustained inappropriate behavior, harassment of an 110 | individual, or aggression toward or disparagement of classes of individuals. 111 | 112 | **Consequence**: A permanent ban from any sort of public interaction within 113 | the community. 114 | 115 | ## Attribution 116 | 117 | This Code of Conduct is adapted from the [Contributor Covenant][homepage], 118 | version 2.0, available at 119 | https://www.contributor-covenant.org/version/2/0/code_of_conduct.html. 120 | 121 | Community Impact Guidelines were inspired by [Mozilla's code of conduct 122 | enforcement ladder](https://github.com/mozilla/diversity). 123 | 124 | [homepage]: https://www.contributor-covenant.org 125 | 126 | For answers to common questions about this code of conduct, see the FAQ at 127 | https://www.contributor-covenant.org/faq. Translations are available at 128 | https://www.contributor-covenant.org/translations. 129 | -------------------------------------------------------------------------------- /.github/settings.yml: -------------------------------------------------------------------------------- 1 | repository: 2 | # See https://developer.github.com/v3/repos/#edit for all available settings. 3 | 4 | # The name of the repository. Changing this will rename the repository 5 | #name: repo-name 6 | 7 | # A short description of the repository that will show up on GitHub 8 | #description: description of repo 9 | 10 | # A URL with more information about the repository 11 | #homepage: https://example.github.io/ 12 | 13 | # A comma-separated list of topics to set on the repository 14 | #topics: project, template, project-template 15 | 16 | # Either `true` to make the repository private, or `false` to make it public. 17 | #private: false 18 | 19 | # Either `true` to enable issues for this repository, `false` to disable them. 20 | #has_issues: true 21 | 22 | # Either `true` to enable the wiki for this repository, `false` to disable it. 23 | #has_wiki: true 24 | 25 | # Either `true` to enable downloads for this repository, `false` to disable them. 26 | #has_downloads: true 27 | 28 | # Updates the default branch for this repository. 29 | #default_branch: master 30 | 31 | # Either `true` to allow squash-merging pull requests, or `false` to prevent 32 | # squash-merging. 33 | #allow_squash_merge: true 34 | 35 | # Either `true` to allow merging pull requests with a merge commit, or `false` 36 | # to prevent merging pull requests with merge commits. 37 | #allow_merge_commit: true 38 | 39 | # Either `true` to allow rebase-merging pull requests, or `false` to prevent 40 | # rebase-merging. 41 | #allow_rebase_merge: true 42 | 43 | # Labels: define labels for Issues and Pull Requests 44 | labels: 45 | - name: 'Type: Bug' 46 | color: e80c0c 47 | description: Something isn't working as expected. 48 | 49 | - name: 'Type: Enhancement' 50 | color: 54b2ff 51 | description: Suggest an improvement for an existing feature. 52 | 53 | - name: 'Type: Feature' 54 | color: 54b2ff 55 | description: Suggest a new feature. 56 | 57 | - name: 'Type: Security' 58 | color: fbff00 59 | description: A problem or enhancement related to a security issue. 60 | 61 | - name: 'Type: Question' 62 | color: 9309ab 63 | description: Request for information. 64 | 65 | - name: 'Type: Test' 66 | color: ce54e3 67 | description: A problem or enhancement related to a test. 68 | 69 | - name: 'Status: Awaiting Review' 70 | color: 24d15d 71 | description: Ready for review. 72 | 73 | - name: 'Status: WIP' 74 | color: 07b340 75 | description: Currently being worked on. 76 | 77 | - name: 'Status: Waiting' 78 | color: 38C968 79 | description: Waiting on something else to be ready. 80 | 81 | - name: 'Status: Stale' 82 | color: 66b38a 83 | description: Has had no activity for some time. 84 | 85 | - name: 'Duplicate' 86 | color: EB862D 87 | description: Duplicate of another issue. 88 | 89 | - name: 'Invalid' 90 | color: faef50 91 | description: This issue doesn't seem right. 92 | 93 | - name: 'Priority: High +' 94 | color: ff008c 95 | description: Task is considered higher-priority. 96 | 97 | - name: 'Priority: Low -' 98 | color: 690a34 99 | description: Task is considered lower-priority. 100 | 101 | - name: 'Documentation' 102 | color: 2fbceb 103 | description: An issue/change with the documentation. 104 | 105 | - name: "Won't fix" 106 | color: C8D9E6 107 | description: Reported issue is working as intended. 108 | 109 | - name: '3rd party issue' 110 | color: e88707 111 | description: This issue might be caused by a 3rd party script/package/other reasons 112 | 113 | - name: 'Os: Windows' 114 | color: AEB1C2 115 | description: Is Windows-specific 116 | 117 | - name: 'Os: Mac' 118 | color: AEB1C2 119 | description: Is Mac-specific 120 | 121 | - name: 'Os: Linux' 122 | color: AEB1C2 123 | description: Is Linux-specific 124 | # # Collaborators: give specific users access to this repository. 125 | # # See https://developer.github.com/v3/repos/collaborators/#add-user-as-a-collaborator for available options 126 | # collaborators: 127 | # # - username: bkeepers 128 | # # permission: push 129 | # # - username: hubot 130 | # # permission: pull 131 | 132 | # # Note: `permission` is only valid on organization-owned repositories. 133 | # # The permission to grant the collaborator. Can be one of: 134 | # # * `pull` - can pull, but not push to or administer this repository. 135 | # # * `push` - can pull and push, but not administer this repository. 136 | # # * `admin` - can pull, push and administer this repository. 137 | # # * `maintain` - Recommended for project managers who need to manage the repository without access to sensitive or destructive actions. 138 | # # * `triage` - Recommended for contributors who need to proactively manage issues and pull requests without write access. 139 | 140 | # # See https://developer.github.com/v3/teams/#add-or-update-team-repository for available options 141 | # teams: 142 | # - name: core 143 | # # The permission to grant the team. Can be one of: 144 | # # * `pull` - can pull, but not push to or administer this repository. 145 | # # * `push` - can pull and push, but not administer this repository. 146 | # # * `admin` - can pull, push and administer this repository. 147 | # # * `maintain` - Recommended for project managers who need to manage the repository without access to sensitive or destructive actions. 148 | # # * `triage` - Recommended for contributors who need to proactively manage issues and pull requests without write access. 149 | # permission: admin 150 | # - name: docs 151 | # permission: push 152 | 153 | # branches: 154 | # - name: master 155 | # # https://developer.github.com/v3/repos/branches/#update-branch-protection 156 | # # Branch Protection settings. Set to null to disable 157 | # protection: 158 | # # Required. Require at least one approving review on a pull request, before merging. Set to null to disable. 159 | # required_pull_request_reviews: 160 | # # The number of approvals required. (1-6) 161 | # required_approving_review_count: 1 162 | # # Dismiss approved reviews automatically when a new commit is pushed. 163 | # dismiss_stale_reviews: true 164 | # # Blocks merge until code owners have reviewed. 165 | # require_code_owner_reviews: true 166 | # # Specify which users and teams can dismiss pull request reviews. Pass an empty dismissal_restrictions object to disable. User and team dismissal_restrictions are only available for organization-owned repositories. Omit this parameter for personal repositories. 167 | # dismissal_restrictions: 168 | # users: [] 169 | # teams: [] 170 | # # Required. Require status checks to pass before merging. Set to null to disable 171 | # required_status_checks: 172 | # # Required. Require branches to be up to date before merging. 173 | # strict: true 174 | # # Required. The list of status checks to require in order to merge into this branch 175 | # contexts: [] 176 | # # Required. Enforce all configured restrictions for administrators. Set to true to enforce required status checks for repository administrators. Set to null to disable. 177 | # enforce_admins: true 178 | # # Prevent merge commits from being pushed to matching branches 179 | # required_linear_history: true 180 | # # Required. Restrict who can push to this branch. Team and user restrictions are only available for organization-owned repositories. Set to null to disable. 181 | # restrictions: 182 | # apps: [] 183 | # users: [] 184 | # teams: [] 185 | -------------------------------------------------------------------------------- /index.html: -------------------------------------------------------------------------------- 1 | Awesome-Repo-Template 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | # Awesome-Repo-Template [![Awesome](https://awesome.re/badge.svg)](https://github.com/MarketingPipeline/Awesome-Repo-Template/) 29 | 30 | 31 | Repo Banner - Awesome Repo Template 32 | 33 |

34 | A awesome repo template to kick-start your next project 35 | 36 |
37 | Show your support! 38 |
39 | 40 | 41 | 42 | 43 | 44 | 45 |

46 | 47 | 48 | ## Features: 49 | 50 | - A configurable workflow action to: 51 | - update all links with your own with EASE! 52 | - update Code Of Conduct E-mail with your own! 53 | - update Security Policy E-mail with your own! 54 | - compress / optimize all images in repo! 55 | - generate a Markdown styled [index file](index.html) with SEO details! 56 | - generate a table of contents in your README 57 | - generate a star-gazer metrics SVG image 58 | - Time Saving Files: 59 | - [Pull request template](.github/pull_request_template.md) 60 | - Issue templates for [bug reports](.github/ISSUE_TEMPLATE/bug_report.yaml) and 61 | [feature requests](.github/ISSUE_TEMPLATE/feature_request.yaml) 62 | - [Contributor guidelines](CONTRIBUTING.md) 63 | - [Code of Conduct](CODE_OF_CONDUCT.md) 64 | - [Change-log](.github/CHANGE_LOG.md) 65 | - [To-Do list](.github/TO_DO.md) 66 | - [Security Policy](.github/SECURITY.md) 67 | - [README](README.md) 68 | - [License file](LICENSE) 69 | 70 | 71 | 72 | 73 | ## Example and Usage 74 | 75 | 76 | 77 | 78 | 79 |
80 |
How to use this template: 81 |
82 | 83 | To run any of these tasks you MUST be in the Actions section 84 | 85 |
How to find the Action 86 | 87 | ![image](https://user-images.githubusercontent.com/86180097/177446180-b71e50d1-df9d-4ef8-8d78-91184702cff0.png) 88 | 89 |
90 | 91 |
92 |
93 | 94 |
How to replace all links with your own: 95 |
96 | 97 | 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 98 | 99 | MyUserName/My-Repo-Name 100 | 101 | And run the Repo Generator in Actions - set "Update all links" to checked 102 |








103 |
104 | 105 |
106 |
107 | 108 |
How to replace e-mail in Code of Conduct with your own: 109 |
110 | 111 | Edit the [repo_config.json](.github/py_repo_tools/repo_config.json) file & set the value for "EMAIL" - to your e-mail address like the following example. 112 | 113 | hello_world@github.com 114 | 115 | And run the Repo Generator in Actions- set "Update Code Of Conduct Info" to checked 116 |








117 |
118 |
119 |
120 | 121 |
How to replace e-mail in Security Policy with your own: 122 |
123 | 124 | Edit the [repo_config.json](.github/py_repo_tools/repo_config.json) file & set the value for "EMAIL" - to your e-mail address like the following example. 125 | 126 | hello_world@github.com 127 | 128 | And run the Repo Generator in Actions- set "Update Security Info" to checked 129 |








130 |
131 |
132 |
133 | 147 |
148 |
149 | 150 |
How to compress / optimize images in repo 151 |
152 | 153 | Note: All images in repo will be compressed / optimized (SVG's are NOT supported) 154 | 155 | Go to the Repo Generator in Actions- set "Compress / Optimize Images" to checked 156 |








157 |
158 |
159 | 160 | 161 |
162 |
163 | 164 |
How to generate Table Of Contents: 165 |
166 | To generate tables of contents automatically use anywhere in your README.md file a comment like so 167 | 168 | 169 | <!-- toc --> 170 | 171 | <!-- tocstop --> 172 | 173 | 174 | And when running the Repo Generator in Actions - set "Generate Table Of Contents" to checked 175 | 176 | 177 | WARNING: Only 1 table of contents can be generated in a README - if you use more than one you WILL face problems. 178 |








179 |
180 | 181 | 182 |
183 | 184 | 185 |
186 |
187 | 188 |
How to Generate a Metrics Image: 189 |
190 | 191 | Create a Personal Access Token & create a repo secret called "METRICS_TOKEN" & when running the Repo Generator - set "Generate Metrics Image File" to checked 192 | 193 | You will have an image generated that looks like this! 194 | 195 | 196 | 197 | It will be placed in the main repo under the filename stargazers-metrics.svg 198 | 199 | Note: if someone knows how to change this please make a pull request with the image placed to .github folder! 200 | 201 | 202 |








203 |
204 | 205 | 206 |








207 |
208 | 209 |
210 | 211 |
Shield.io Buttons: 212 |
213 | 214 | 215 | 216 | _Repo metadata_ 217 | 218 | 219 | [![Github license](https://img.shields.io/github/license/MarketingPipeline/Awesome-Repo-Template.svg "Github license")](https://github.com/MarketingPipeline/Awesome-Repo-Template/blob/master/LICENSE) 220 | [![Open issues](https://img.shields.io/github/issues/MarketingPipeline/Awesome-Repo-Template.svg "Open issues")](https://github.com/MarketingPipeline/Awesome-Repo-Template/issues) 221 | [![Closed issues](https://img.shields.io/github/issues-closed/MarketingPipeline/Awesome-Repo-Template.svg "Closed issues")](https://github.com/MarketingPipeline/Awesome-Repo-Template/issues?utf8=✓&q=is%3Aissue+is%3Aclosed) 222 | [![Open Pull Requests](https://img.shields.io/github/issues-pr/MarketingPipeline/Awesome-Repo-Template.svg "Open Pull Requests")](https://github.com/MarketingPipeline/Awesome-Repo-Template/pulls) 223 | [![Closed Pull Requests](https://img.shields.io/github/issues-pr-closed/MarketingPipeline/Awesome-Repo-Template.svg "Closed Pull Requests")](https://github.com/MarketingPipeline/Awesome-Repo-Template/pulls?utf8=✓&q=is%3Apr+is%3Aclosed) 224 | [![Commit activity](https://img.shields.io/github/commit-activity/m/MarketingPipeline/Awesome-Repo-Template.svg "Commit activity")](https://github.com/MarketingPipeline/Awesome-Repo-Template/graphs/commit-activity) 225 | [![GitHub contributors](https://img.shields.io/github/contributors/MarketingPipeline/Awesome-Repo-Template.svg "Github contributors")](https://github.com/MarketingPipeline/Awesome-Repo-Template/graphs/contributors) 226 | [![Last commit](https://img.shields.io/github/last-commit/MarketingPipeline/Awesome-Repo-Template.svg "Last commit")](https://github.com/MarketingPipeline/Awesome-Repo-Template/commits/master) 227 | [![GitHub tag](https://img.shields.io/github/tag/MarketingPipeline/Awesome-Repo-Template?include_prereleases=&sort=semver&color=blue)](https://github.com/MarketingPipeline/Awesome-Repo-Template/releases/) 228 | 229 | 230 | 231 | _Social buttons_ 232 | 233 | [![MarketingPipeline - Awesome-Repo-Template](https://img.shields.io/static/v1?label=MarketingPipeline&message=Awesome-Repo-Template&color=blue&logo=github)](https://github.com/MarketingPipeline/Awesome-Repo-Template "Go to GitHub repo") 234 | [![stars - Awesome-Repo-Template](https://img.shields.io/github/stars/MarketingPipeline/Awesome-Repo-Template?style=social)](https://github.com/MarketingPipeline/Awesome-Repo-Template) 235 | [![forks - Awesome-Repo-Template](https://img.shields.io/github/forks/MarketingPipeline/Awesome-Repo-Template?style=social)](https://github.com/MarketingPipeline/Awesome-Repo-Template) 236 | 237 | 238 | 239 | _Call-to-Action buttons_ 240 | 241 | 242 | 243 | [![Use this template](https://img.shields.io/badge/Generate-Use_this_template-2ea44f?style=for-the-badge)](https://github.com/MarketingPipeline/Awesome-Repo-Template/generate) 244 | 245 | [![View site - GH Pages](https://img.shields.io/badge/View_site-GH_Pages-2ea44f?style=for-the-badge)](https://marketingpip.github.io/Awesome-Repo-Template/) 246 | 247 | 248 | _Documentation button_ 249 | 250 | 251 | [![view - Documentation](https://img.shields.io/badge/view-Documentation-blue?style=for-the-badge)](/README.MD "Go to project documentation") 252 | 253 | 254 | _Custom button_ 255 | 256 | Custom Shield.io Button 257 | 258 | 259 |








260 |
261 | 262 |
263 | 264 | 265 |
Auto Generated Table Of Contents Demo: 266 |
267 | 270 | 271 | - [Features:](#features) 272 | - [Example and Usage](#example-and-usage) 273 | - [Contributing ![GitHub](https://img.shields.io/github/contributors/MarketingPipeline/Awesome-Repo-Template) ](#contributing-a-hrefhttpsgithubcommarketingpipelineawesome-repo-templategraphscontributors-githubhttpsimgshieldsiogithubcontributorsmarketingpipelineawesome-repo-template-a) 274 | - [License ![GitHub](https://img.shields.io/github/license/MarketingPipeline/Awesome-Repo-Template) ](#license-a-hreflicense-githubhttpsimgshieldsiogithublicensemarketingpipelineawesome-repo-template-a) 275 | 276 | 277 | 278 |
279 | 280 | 281 | 282 | 283 | 284 | 285 | 286 | 287 | 288 | ## Contributing ![GitHub](https://img.shields.io/github/contributors/MarketingPipeline/Awesome-Repo-Template) 289 | 290 | Want to improve this template? Create a pull request with detailed changes / improvements! If approved you will be added to the list of contributors of this awesome repo template! 291 | 292 | See also the list of 293 | [contributors](https://github.com/MarketingPipeline/Awesome-Repo-Template/graphs/contributors) who 294 | participate in this project. 295 | 296 | ## License ![GitHub](https://img.shields.io/github/license/MarketingPipeline/Awesome-Repo-Template) 297 | 298 | This project is licensed under the MIT License - see the 299 | [LICENSE.md](https://github.com/MarketingPipeline/Awesome-Repo-Template/blob/main/LICENSE) file for 300 | details. 301 | 302 | 303 | 304 | 305 | 306 | 307 | 308 | 309 | 310 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Awesome-Repo-Template [![Awesome](https://awesome.re/badge.svg)](https://github.com/MarketingPipeline/Awesome-Repo-Template/) 2 | 3 | 4 | Repo Banner - Awesome Repo Template 5 | 6 |

7 | A awesome repo template to kick-start your next project 8 | 9 |
10 | Show your support! 11 |
12 | 13 | 14 | 15 | 16 | 17 | 18 |

19 | 20 | 21 | ## Features: 22 | 23 | - A configurable workflow action to: 24 | - update all links with your own with EASE! 25 | - update Code Of Conduct E-mail with your own! 26 | - update Security Policy E-mail with your own! 27 | - download files & folder from another GitHub Repo 28 | - compress / optimize all images in repo! 29 | - generate a Markdown styled [index file](index.html) with SEO details! 30 | - generate a table of contents in your README 31 | - generate a star-gazer metrics SVG image 32 | - Time Saving Files: 33 | - [Pull request template](.github/pull_request_template.md) 34 | - Issue templates for [bug reports](.github/ISSUE_TEMPLATE/bug_report.yaml) and 35 | [feature requests](.github/ISSUE_TEMPLATE/feature_request.yaml) 36 | - [Contributor guidelines](.github/CONTRIBUTING.md) 37 | - [Code Owners](.github/CODEOWNERS) 38 | - [Code of Conduct](.github/CODE_OF_CONDUCT.md) 39 | - [Change-log](.github/CHANGE_LOG.md) 40 | - [To-Do list](.github/TO_DO.md) 41 | - [Security Policy](.github/SECURITY.md) 42 | - [README](README.md) 43 | - [License file](LICENSE) 44 | - GitHub Bot Files 45 | - [config.yml](/.github/config.yml) file to modify multiple bot's behaviours. 46 | - [issue_label_bot.yaml](/.github/issue_label_bot.yaml) file to use the issue adder GitHub bot. [Activate it or check its documentation](https://github.com/marketplace/issue-label-bot). 47 | - [settings.yml](/.github/settings.yml) file to use the popular settings GitHub bot. [Activate it or check its documentation](https://probot.github.io/apps/settings/). 48 | 49 | 50 | 51 | ## Example and Usage 52 | 53 | 54 | 55 | 56 | 57 |
58 |
How to use this template: 59 |
60 | 61 | To run any of these tasks you MUST be in the Actions section 62 | 63 |
How to find the Action 64 | 65 | ![image](https://user-images.githubusercontent.com/86180097/177446180-b71e50d1-df9d-4ef8-8d78-91184702cff0.png) 66 | 67 |
68 | 69 |
70 |
71 | 72 |
How to replace all links with your own: 73 |
74 | 75 | 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 76 | 77 | MyUserName/My-Repo-Name 78 | 79 | And run the Repo Generator in Actions - set "Update all links" to checked 80 |








81 |
82 | 83 |
84 |
85 | 86 |
How to replace e-mail in Code of Conduct with your own: 87 |
88 | 89 | Edit the [repo_config.json](.github/py_repo_tools/repo_config.json) file & set the value for "EMAIL" - to your e-mail address like the following example. 90 | 91 | hello_world@github.com 92 | 93 | And run the Repo Generator in Actions- set "Update Code Of Conduct Info" to checked 94 |








95 |
96 |
97 |
98 | 99 |
How to replace e-mail in Security Policy with your own: 100 |
101 | 102 | Edit the [repo_config.json](.github/py_repo_tools/repo_config.json) file & set the value for "EMAIL" - to your e-mail address like the following example. 103 | 104 | hello_world@github.com 105 | 106 | And run the Repo Generator in Actions- set "Update Security Info" to checked 107 |








108 |
109 | 110 |
111 |
112 | 113 |
How to download file(s) / folder(s) from another GitHub repo 114 |
115 | 116 |
117 |

WARNING

118 | files downloaded from a repo containing the same name in your current repo will be OVER-WRITTEN. 119 |



120 | 121 | In the Repo Generator Actions- set "Download a file or folder from a GitHub Repo" to a GitHub file path or folder. 122 | 123 | 124 | Example(s) 125 | 126 | 127 | To download a single file: 128 | 129 | https://github.com/Repo-Owner-UserName/Repo-Name/blob/master/README.md 130 | 131 | 132 | To download a specific folder: 133 | 134 | https://github.com/Repo-Owner-UserName/Repo-Name/blob/master/Folder-Name 135 | 136 | 137 | 138 | To download all files in a repo folder: 139 | 140 | https://github.com/Repo-Owner-UserName/Repo-Name/blob/master/ 141 | 142 | 143 | 144 | Note: File's will be placed into main repo path. 145 | 146 |








147 |
148 | 149 |
150 |
151 | 152 |
How to generate a index.html file 153 |
154 | 155 | 156 | A index.html file will be produced from your README content. 157 | 158 | SEO details such as Title, Description & OG images etc are auto-produced using your Repo details. 159 | 160 | Note Your README content will be rendered in Github Flavored Markdown using our tool [Markdown-Tag: Add Markdown to any HTML using a tag](https://github.com/MarketingPipeline/Markdown-Tag) 161 | 162 | Go to the Repo Generator in Actions- set "Generate Index File" to checked 163 |








164 |
165 |
166 |
167 | 168 |
How to compress / optimize images in repo 169 |
170 | 171 | Note: All images in repo will be compressed / optimized (SVG's are NOT supported) 172 | 173 | Go to the Repo Generator in Actions- set "Compress / Optimize Images" to checked 174 |








175 |
176 |
177 | 178 | 179 |
180 |
181 | 182 |
How to generate Table Of Contents: 183 |
184 | To generate tables of contents automatically use anywhere in your README.md file a comment like so 185 | 186 | 187 | <!-- toc --> 188 | 189 | <!-- tocstop --> 190 | 191 | 192 | And when running the Repo Generator in Actions - set "Generate Table Of Contents" to checked 193 | 194 | 195 | WARNING: Only 1 table of contents can be generated in a README - if you use more than one you WILL face problems. 196 |








197 |
198 | 199 | 200 |
201 | 202 | 203 |
204 |
205 | 206 |
How to Generate a Metrics Image: 207 |
208 | 209 | Create a Personal Access Token & create a repo secret called "METRICS_TOKEN" & when running the Repo Generator - set "Generate Metrics Image File" to checked 210 | 211 | You will have an image generated that looks like this! 212 | 213 | 214 | 215 | It will be placed in the main repo under the filename stargazers-metrics.svg 216 | 217 | Note: if someone knows how to change this please make a pull request with the image placed to .github folder! 218 | 219 | 220 |








221 |
222 | 223 | 224 |








225 |
226 | 227 |
228 | 229 |
Shield.io Buttons: 230 |
231 | 232 | 233 | 234 | _Repo metadata_ 235 | 236 | 237 | [![Github license](https://img.shields.io/github/license/MarketingPipeline/Awesome-Repo-Template.svg "Github license")](https://github.com/MarketingPipeline/Awesome-Repo-Template/blob/master/LICENSE) 238 | [![Open issues](https://img.shields.io/github/issues/MarketingPipeline/Awesome-Repo-Template.svg "Open issues")](https://github.com/MarketingPipeline/Awesome-Repo-Template/issues) 239 | [![Closed issues](https://img.shields.io/github/issues-closed/MarketingPipeline/Awesome-Repo-Template.svg "Closed issues")](https://github.com/MarketingPipeline/Awesome-Repo-Template/issues?utf8=✓&q=is%3Aissue+is%3Aclosed) 240 | [![Open Pull Requests](https://img.shields.io/github/issues-pr/MarketingPipeline/Awesome-Repo-Template.svg "Open Pull Requests")](https://github.com/MarketingPipeline/Awesome-Repo-Template/pulls) 241 | [![Closed Pull Requests](https://img.shields.io/github/issues-pr-closed/MarketingPipeline/Awesome-Repo-Template.svg "Closed Pull Requests")](https://github.com/MarketingPipeline/Awesome-Repo-Template/pulls?utf8=✓&q=is%3Apr+is%3Aclosed) 242 | [![Commit activity](https://img.shields.io/github/commit-activity/m/MarketingPipeline/Awesome-Repo-Template.svg "Commit activity")](https://github.com/MarketingPipeline/Awesome-Repo-Template/graphs/commit-activity) 243 | [![GitHub contributors](https://img.shields.io/github/contributors/MarketingPipeline/Awesome-Repo-Template.svg "Github contributors")](https://github.com/MarketingPipeline/Awesome-Repo-Template/graphs/contributors) 244 | [![Last commit](https://img.shields.io/github/last-commit/MarketingPipeline/Awesome-Repo-Template.svg "Last commit")](https://github.com/MarketingPipeline/Awesome-Repo-Template/commits/master) 245 | [![GitHub tag](https://img.shields.io/github/tag/MarketingPipeline/Awesome-Repo-Template?include_prereleases=&sort=semver&color=blue)](https://github.com/MarketingPipeline/Awesome-Repo-Template/releases/) 246 | 247 | 248 | 249 | _Social buttons_ 250 | 251 | [![MarketingPipeline - Awesome-Repo-Template](https://img.shields.io/static/v1?label=MarketingPipeline&message=Awesome-Repo-Template&color=blue&logo=github)](https://github.com/MarketingPipeline/Awesome-Repo-Template "Go to GitHub repo") 252 | [![stars - Awesome-Repo-Template](https://img.shields.io/github/stars/MarketingPipeline/Awesome-Repo-Template?style=social)](https://github.com/MarketingPipeline/Awesome-Repo-Template) 253 | [![forks - Awesome-Repo-Template](https://img.shields.io/github/forks/MarketingPipeline/Awesome-Repo-Template?style=social)](https://github.com/MarketingPipeline/Awesome-Repo-Template) 254 | 255 | 256 | 257 | _Call-to-Action buttons_ 258 | 259 | 260 | 261 | [![Use this template](https://img.shields.io/badge/Generate-Use_this_template-2ea44f?style=for-the-badge)](https://github.com/MarketingPipeline/Awesome-Repo-Template/generate) 262 | 263 | [![View site - GH Pages](https://img.shields.io/badge/View_site-GH_Pages-2ea44f?style=for-the-badge)](https://marketingpip.github.io/Awesome-Repo-Template/) 264 | 265 | 266 | _Documentation button_ 267 | 268 | 269 | [![view - Documentation](https://img.shields.io/badge/view-Documentation-blue?style=for-the-badge)](/README.MD "Go to project documentation") 270 | 271 | 272 | _Custom button_ 273 | 274 | Custom Shield.io Button 275 | 276 | 277 |








278 |
279 | 280 |
281 | 282 | 283 |
Auto Generated Table Of Contents Demo: 284 |
285 | 288 | 289 | - [Features:](#features) 290 | - [Example and Usage](#example-and-usage) 291 | - [Contributing ![GitHub](https://img.shields.io/github/contributors/MarketingPipeline/Awesome-Repo-Template) ](#contributing-a-hrefhttpsgithubcommarketingpipelineawesome-repo-templategraphscontributors-githubhttpsimgshieldsiogithubcontributorsmarketingpipelineawesome-repo-template-a) 292 | - [License ![GitHub](https://img.shields.io/github/license/MarketingPipeline/Awesome-Repo-Template) ](#license-a-hreflicense-githubhttpsimgshieldsiogithublicensemarketingpipelineawesome-repo-template-a) 293 | 294 | 295 | 296 |
297 | 298 | 299 | 300 |
301 |
302 | How to setup GitHub bots 303 | 304 |
305 | These are bots that are prepared and configured for this template. They need to be activated to properly work. 306 | 307 |
308 |
309 | 310 | 1. The `issue_label_bot.yaml` file depends on the **issue label bot** [Activate it or check its documentation](https://github.com/marketplace/issue-label-bot)(✓ highly recommended). 311 | 2. The `settings.yml` file depends on the **settings label bot** [Activate it or check its documentation](https://probot.github.io/apps/settings/) (optional). 312 | 3. The `config.yml` file depends on the bot **welcome bot** [Activate it or check its documentation](https://probot.github.io/apps/welcome/) and [to-do bot](https://probot.github.io/apps/todo/) (optional). 313 | 314 |
315 | 316 | 317 | 318 | 319 | 320 | ## Contributing ![GitHub](https://img.shields.io/github/contributors/MarketingPipeline/Awesome-Repo-Template) 321 | 322 | Want to improve this template? Create a pull request with detailed changes / improvements! If approved you will be added to the list of contributors of this awesome repo template! 323 | 324 | See also the list of 325 | [contributors](https://github.com/MarketingPipeline/Awesome-Repo-Template/graphs/contributors) who 326 | participate in this project. 327 | 328 | ## License ![GitHub](https://img.shields.io/github/license/MarketingPipeline/Awesome-Repo-Template) 329 | 330 | This project is licensed under the MIT License - see the 331 | [LICENSE.md](https://github.com/MarketingPipeline/Awesome-Repo-Template/blob/main/LICENSE) file for 332 | details. 333 | 334 | 335 | 336 | 337 | -------------------------------------------------------------------------------- /stargazers-metrics.svg: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 |
9 |
10 |

11 | 12 | 13 | 14 | Stargazers over the last two weeks 15 |

16 |
17 |
18 |

Total stargazers

19 |
20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 | 39 | 40 | 41 | 42 | 43 | 44 | 45 | 46 | 47 | 00000000000000 48 | 49 | 50 | 23 June 51 | 24 52 | 25 53 | 26 54 | 27 55 | 28 56 | 29 57 | 30 58 | 01 July 59 | 02 60 | 03 61 | 04 62 | 05 63 | 06 64 | 65 | 66 |
67 |
68 |
69 |
70 |
71 |

New stargazers per day

72 |
73 | 74 | 75 | 76 | 77 | 78 | 79 | 80 | 81 | 82 | 83 | 84 | 85 | 86 | 87 | 88 | 89 | 90 | 91 | 92 | 93 | 94 | 95 | 96 | 97 | 98 | 99 | 100 | 00000000000000 101 | 102 | 103 | 23 June 104 | 24 105 | 25 106 | 26 107 | 27 108 | 28 109 | 29 110 | 30 111 | 01 July 112 | 02 113 | 03 114 | 04 115 | 05 116 | 06 117 | 118 | 119 |
120 |
121 |
122 |
123 |
124 |
125 |
126 |
127 | 128 | --------------------------------------------------------------------------------