-
Notifications
You must be signed in to change notification settings - Fork 39
/
index.html
309 lines (189 loc) · 12.9 KB
/
index.html
1
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
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
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
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
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
<head><title>Awesome-Repo-Template</title>
<!-- Primary Meta Tags -->
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Awesome-Repo-Template">
<meta name="description" content="An awesome repo template to kick-start your next project / repo">
<!-- Open Graph / Facebook -->
<meta property="og:type" content="website">
<meta property="og:url" content="https://MarketingPipeline.github.io/Awesome-Repo-Template">
<meta property="og:title" content="An awesome repo template to kick-start your next project / repo">
<meta property="og:description" content="An awesome repo template to kick-start your next project / repo">
<meta property="og:image" content="https://og-image.vercel.app/Awesome-Repo-Template.png?theme=light&md=0&fontSize=100px&images=https%3A%2F%2Fassets.vercel.com%2Fimage%2Fupload%2Ffront%2Fassets%2Fdesign%2Fhyper-color-logo.svg">
<!-- Twitter -->
<meta property="twitter:card" content="summary_large_image">
<meta property="twitter:url" content="https://MarketingPipeline.github.io/Awesome-Repo-Template">
<meta property="twitter:title" content="Awesome-Repo-Template">
<meta property="twitter:description" content="An awesome repo template to kick-start your next project / repo">
<meta property="twitter:image" content="https://og-image.vercel.app/Awesome-Repo-Template.png?theme=light&md=0&fontSize=100px&images=https%3A%2F%2Fassets.vercel.com%2Fimage%2Fupload%2Ffront%2Fassets%2Fdesign%2Fhyper-color-logo.svg">
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.28.0/prism.min.js"></script>
</head>
<!--Body Content -->
<body>
<github-md>
# Awesome-Repo-Template [](https://github.com/MarketingPipeline/Awesome-Repo-Template/)
<a href="https://github.com/MarketingPipeline/Awesome-Repo-Template/">
<img height=350 alt="Repo Banner - Awesome Repo Template" src="https://capsule-render.vercel.app/api?type=waving&color=c4a2bd&height=300§ion=header&text=Awesome%Repo%-Template&fontSize=70&fontColor=ffffff&animation=fadeIn&fontAlignY=38&desc=Easily%20setup%20your%20next%20repo!&descAlignY=60&descAlign=50"></img></a>
<p align="center">
<b>A awesome repo template to kick-start your next project</b>
<br>
<small> <b><i>Show your support!</i> </b></small>
<br>
<a href="https://github.com/MarketingPipeline/Awesome-Repo-Template">
<img title="Star on GitHub" src="https://img.shields.io/github/stars/MarketingPipeline/Awesome-Repo-Template.svg?style=social&label=Star">
</a>
<a href="https://github.com/MarketingPipeline/Awesome-Repo-Template/fork">
<img title="Fork on GitHub" src="https://img.shields.io/github/forks/MarketingPipeline/Awesome-Repo-Template.svg?style=social&label=Fork">
</a>
</p>
## Features:
- A configurable workflow action to:
- update all links with your own with EASE!
- update Code Of Conduct E-mail with your own!
- update Security Policy E-mail with your own!
- compress / optimize all images in repo!
- generate a Markdown styled [index file](index.html) with SEO details!
- generate a table of contents in your README
- generate a star-gazer metrics SVG image
- Time Saving Files:
- [Pull request template](.github/pull_request_template.md)
- Issue templates for [bug reports](.github/ISSUE_TEMPLATE/bug_report.yaml) and
[feature requests](.github/ISSUE_TEMPLATE/feature_request.yaml)
- [Contributor guidelines](CONTRIBUTING.md)
- [Code of Conduct](CODE_OF_CONDUCT.md)
- [Change-log](.github/CHANGE_LOG.md)
- [To-Do list](.github/TO_DO.md)
- [Security Policy](.github/SECURITY.md)
- [README](README.md)
- [License file](LICENSE)
## Example and Usage
<br>
<details><summary>How to use this <b>template</b>:</summary>
<br>
To run any of these tasks you MUST be in the <b>Actions section</b>
<details><summary>How to find the <a href="https://github.com/MarketingPipeline/Awesome-Repo-Template/actions"><b>Action</b></a></summary>
<a href="https://github.com/MarketingPipeline/Awesome-Repo-Template/actions">  </a>
</details>
<br>
<br>
<details><summary>How to replace all <b>links</b> with your own:</summary>
<br>
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 <code>checked</code>
<br> <br> <br> <br> <br> <br> <br> <br> <br>
</details>
<br>
<br>
<details><summary>How to replace <b>e-mail</b> in <a href="CODE_OF_CONDUCT.md">Code of Conduct</a> with your own:</summary>
<br>
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.
hello_world@github.com
And run the Repo Generator in Actions- set "Update Code Of Conduct Info" to <code>checked</code>
<br> <br> <br> <br> <br> <br> <br> <br> <br>
</details>
<br>
<br>
<details><summary>How to replace <b>e-mail</b> in <a href=".github/SECURITY.md">Security Policy</a> with your own:</summary>
<br>
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.
hello_world@github.com
And run the Repo Generator in Actions- set "Update Security Info" to <code>checked</code>
<br> <br> <br> <br> <br> <br> <br> <br> <br>
</details>
<br>
<br>
<!------Markdown Issue
<details><summary>How to generate a <b>index.html</b> file</summary>
<br>
A index.html file will be produced from your README content.
SEO details such as Title, Description & OG images etc are auto-produced using your Repo details.
<b>Note</b> Your README content will be rendered in Github Flavored Markdown using our tool [Markdown-Tag: Add Markdown to any HTML using a <md> tag](https://github.com/MarketingPipeline/Markdown-Tag)
Go to the Repo Generator in Actions- set "Generate Index File" to <code>checked</code>
<br> <br> <br> <br> <br> <br> <br> <br> <br>
</details>------------>
<br>
<br>
<details><summary>How to <b>compress / optimize</b> images in repo</summary>
<br>
<b><i>Note:</b></i> All images in repo will be compressed / optimized (SVG's are NOT supported)
Go to the Repo Generator in Actions- set "Compress / Optimize Images" to <code>checked</code>
<br> <br> <br> <br> <br> <br> <br> <br> <br>
</details>
<br>
<br>
<br>
<details><summary>How to generate <b>Table Of Contents</b>:</summary>
<br>
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 <code>checked</code>
<b><i>WARNING:</i></b> Only 1 table of contents can be generated in a README - if you use more than one you WILL face problems.
<br> <br> <br> <br> <br> <br> <br> <br> <br>
</details>
<br>
<br>
<br>
<details><summary>How to Generate a <b>Metrics Image</b>:</summary>
<br>
Create a Personal Access Token & create a repo secret called "METRICS_TOKEN" & when running the Repo Generator - set "Generate Metrics Image File" to <code>checked</code>
You will have an image generated that looks like this!
<img src="stargazers-metrics.svg"></img>
It will be placed in the main repo under the filename <code>stargazers-metrics.svg</code>
<i>Note:</i> if someone knows how to change this please make a pull request with the image placed to .github folder!
<br> <br> <br> <br> <br> <br> <br> <br> <br>
</details>
<br> <br> <br> <br> <br> <br> <br> <br> <br>
</details>
<br>
<details><summary>Shield.io Buttons:</summary>
<br>
<!--Copy & paste whatever buttons you need!-->
_Repo metadata_
[](https://github.com/MarketingPipeline/Awesome-Repo-Template/blob/master/LICENSE)
[](https://github.com/MarketingPipeline/Awesome-Repo-Template/issues)
[](https://github.com/MarketingPipeline/Awesome-Repo-Template/issues?utf8=✓&q=is%3Aissue+is%3Aclosed)
[](https://github.com/MarketingPipeline/Awesome-Repo-Template/pulls)
[](https://github.com/MarketingPipeline/Awesome-Repo-Template/pulls?utf8=✓&q=is%3Apr+is%3Aclosed)
[](https://github.com/MarketingPipeline/Awesome-Repo-Template/graphs/commit-activity)
[](https://github.com/MarketingPipeline/Awesome-Repo-Template/graphs/contributors)
[](https://github.com/MarketingPipeline/Awesome-Repo-Template/commits/master)
[](https://github.com/MarketingPipeline/Awesome-Repo-Template/releases/)
_Social buttons_
[](https://github.com/MarketingPipeline/Awesome-Repo-Template "Go to GitHub repo")
[](https://github.com/MarketingPipeline/Awesome-Repo-Template)
[](https://github.com/MarketingPipeline/Awesome-Repo-Template)
_Call-to-Action buttons_
[](https://github.com/MarketingPipeline/Awesome-Repo-Template/generate)
[](https://marketingpip.github.io/Awesome-Repo-Template/)
_Documentation button_
[](/README.MD "Go to project documentation")
_Custom button_
<img alt="Custom Shield.io Button" src="https://img.shields.io/badge/Custom-Button-blue.svg?style=flat-square"></img>
<br> <br> <br> <br> <br> <br> <br> <br> <br>
</details>
<br>
<details><summary>Auto Generated Table Of Contents <b> Demo</b>:</summary>
<br>
<!------- Table Of Contents Will Auto Generate In Side Of Here ---- >
<!-- toc -->
- [Features:](#features)
- [Example and Usage](#example-and-usage)
- [Contributing <a href="https://github.com/MarketingPipeline/Awesome-Repo-Template/graphs/contributors">  </a>](#contributing-a-hrefhttpsgithubcommarketingpipelineawesome-repo-templategraphscontributors-githubhttpsimgshieldsiogithubcontributorsmarketingpipelineawesome-repo-template-a)
- [License <a href="LICENSE">  </a>](#license-a-hreflicense-githubhttpsimgshieldsiogithublicensemarketingpipelineawesome-repo-template-a)
<!-- tocstop -->
</details>
## Contributing <a href="https://github.com/MarketingPipeline/Awesome-Repo-Template/graphs/contributors">  </a>
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!
See also the list of
[contributors](https://github.com/MarketingPipeline/Awesome-Repo-Template/graphs/contributors) who
participate in this project.
## License <a href="LICENSE">  </a>
This project is licensed under the MIT License - see the
[LICENSE.md](https://github.com/MarketingPipeline/Awesome-Repo-Template/blob/main/LICENSE) file for
details.
</github-md>
</body>
<script src="https://cdn.jsdelivr.net/gh/MarketingPipeline/Markdown-Tag/markdown-tag-GitHub.js"></script>