-
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathindex.html
216 lines (160 loc) · 7.87 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
<head><title>project-template-repo</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="project-template-repo">
<meta name="description" content="Your starting point for streamlined project setups. Jumpstart your development with this versatile template. 🚀📁">
<!-- Open Graph / Facebook -->
<meta property="og:type" content="website">
<meta property="og:url" content="https://smcnab1.github.io/project-template-repo">
<meta property="og:title" content="Your starting point for streamlined project setups. Jumpstart your development with this versatile template. 🚀📁">
<meta property="og:description" content="Your starting point for streamlined project setups. Jumpstart your development with this versatile template. 🚀📁">
<meta property="og:image" content="https://og-image.vercel.app/project-template-repo.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://smcnab1.github.io/project-template-repo">
<meta property="twitter:title" content="project-template-repo">
<meta property="twitter:description" content="Your starting point for streamlined project setups. Jumpstart your development with this versatile template. 🚀📁">
<meta property="twitter:image" content="https://og-image.vercel.app/project-template-repo.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>
<!-- TOP ROW OF BADGES -->
[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![MIT License][license-shield]][license-url]
[![Kofi][kofi-badge]][kofi-url]
<a name="readme-top"></a>
<!-- PROJECT LOGO -->
<br />
<div align="center">
<a href="https://github.com/smcnab1/project-template-repo">
<img src="images/avatar.png" alt="Logo" width="80" height="80">
</a>
<h3 align="center">Project Template Repo</h3>
<p align="center">
Jumpstart your development with this versatile template. 🚀📁
<br />
<a href="https://github.com/smcnab1/project-template-repo"><strong>Explore the docs »</strong></a>
<br />
<br />
<a href="https://github.com/smcnab1/project-template-repo">View Demo</a>
·
<a href="https://github.com/smcnab1/project-template-repo/issues">Report Bug</a>
·
<a href="https://github.com/smcnab1/project-template-repo/issues">Request Feature</a>
</p>
</div>
<details>
<summary>View Contents</summary>
_Last Updated DATE_
<!-- toc -->
- [About The Project](#about-the-project)
- [Features](#features)
- [Built with](#built-with)
- [Getting started](#getting-started)
- [Prerequisites](#prerequisites)
- [Install](#install)
- [Usage](#usage)
- [Back Matter](#back-matter)
- [Roadmap](#roadmap)
- [Contributing](#contributing)
- [License](#license)
<!-- tocstop -->
</details>
<!-- ABOUT THE PROJECT -->
## About The Project
<div align="center">
<a href="https://github.com/smcnab1/project-template-repo">
<img src="images/screenshot.png" alt="Logo" width="100%" height="auto">
</a>
</div>
This repository can be used as a template to load your new repository with ease. Including the following features to save your time in generating new repositories.
<p align="right">(<a href="#readme-top">back to top</a>)</p>
### Features
- Auto-Update Documentation Links with current repo name
- Update Email Addresses: CODE_OF_CONDUCT, SECURITY.
- Download files & folders from another GitHub Repo
- Generate Markdown styled index file with SEO details
- Generate Table of Contents into README
- Several files already created for you as a template
### Built with
- Markdown
- Python
- GitHub Actions
- Shell
<p align="right">(<a href="#readme-top">back to top</a>)</p>
## Getting started
### Prerequisites
Accessible using browser or GitHub mobile application.
### Install
1. Click on [use template](https://github.com/new?template_name=project-template-repo&template_owner=smcnab1) to generate new repository from template.
2. Enter repository name and Description.
3. Generate new repository.
4. Navigate to **Settings > Actions > General** and set ***Workflow Permissions*** to _Read and write permissions_
### Usage
- Repository Link Updater
- WIP
- License Date Updater
- WIP
- Code of Conduct Email Updater
- WIP
- Security Policy Email Updater
- WIP
- Table of Contents Generator
- WIP
- Index File Generator
- WIP
- Combinations
- WIP
<p align="right">(<a href="#readme-top">back to top</a>)</p>
## Back Matter
<!-- ROADMAP -->
### Roadmap
- [ ] Finalise Documentation.
- [ ] Remove need for config file, all set within Actions.
- [ ] Combination Selection instead of individual options.
See the [open issues](https://github.com/smcnab1/project-template-repo/issues) for a full list of proposed features (and known issues).
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- CONTRIBUTING -->
<a name="contributing"></a>
### 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**.
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" or "feature-request".
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`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request
### License
This project is licensed under the [MIT License](LICENSE.md).
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- MARKDOWN LINKS & IMAGES -->
[contributors-shield]: https://img.shields.io/github/contributors/smcnab1/project-template-repo.svg?style=for-the-badge
[contributors-url]: https://github.com/smcnab1/project-template-repo/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/smcnab1/project-template-repo.svg?style=for-the-badge
[forks-url]: https://github.com/smcnab1/project-template-repo/network/members
[stars-shield]: https://img.shields.io/github/stars/smcnab1/project-template-repo.svg?style=for-the-badge
[stars-url]: https://github.com/smcnab1/project-template-repo/stargazers
[issues-shield]: https://img.shields.io/github/issues/smcnab1/project-template-repo.svg?style=for-the-badge
[issues-url]: https://github.com/smcnab1/project-template-repo/issues
[license-shield]: https://img.shields.io/github/license/smcnab1/project-template-repo.svg?style=for-the-badge
[license-url]: https://github.com/smcnab1/project-template-repo/blob/master/LICENSE.md
[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555
[linkedin-url]: https://www.linkedin.com/in/sammcnab/
[product-screenshot]: images/screenshot.png
[email-badge]: https://img.shields.io/badge/Email-D14836?style=for-the-badge&logo=gmail&logoColor=white
[email-url]: mailto:sam@sammcnab.co.uk
[git-badge]: https://img.shields.io/badge/GitHub-100000?style=for-the-badge&logo=github&logoColor=white
[git-url]: https://github.com/smcnab1
[kofi-badge]: https://ko-fi.com/img/githubbutton_sm.svg
[kofi-url]: https://ko-fi.com/sammcnab1
</github-md>
</body>
<script src="https://cdn.jsdelivr.net/gh/MarketingPipeline/Markdown-Tag/markdown-tag-GitHub.js"></script>