https://github.com/zheng-bote/repo-template
Template for new Github repositories
https://github.com/zheng-bote/repo-template
documentation github readme-template repo templates
Last synced: 3 months ago
JSON representation
Template for new Github repositories
- Host: GitHub
- URL: https://github.com/zheng-bote/repo-template
- Owner: Zheng-Bote
- License: mit
- Created: 2024-09-03T15:25:00.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2025-04-14T15:15:32.000Z (about 1 year ago)
- Last Synced: 2026-01-29T01:46:33.803Z (5 months ago)
- Topics: documentation, github, readme-template, repo, templates
- Homepage: https://zheng-bote.github.io/repo-template/
- Size: 433 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
GH Repo Template
Template for new Github repos
[Report Issue](https://github.com/Zheng-Bote/repo-template/issues) [Request Feature](https://github.com/Zheng-Bote/repo-template/pulls)
[](https://choosealicense.com/licenses/mit/)
[](https://github.com/Zheng-Bote/repo-template/releases)
**Table of Contents**
- [Description](#description)
- [Features](#features)
- [Status](#status)
- [Documentation](#documentation)
- [README](#readme)
- [other Markdown files](#other-markdown-files)
- [Installation](#installation)
- [Dependencies](#dependencies)
- [folder structure](#folder-structure)
- [Usage/Examples/Tests](#usageexamplestests)
- [API Reference](#api-reference)
- [Inputs](#inputs)
- [Outputs](#outputs)
- [Parameters](#parameters)
- [Documentation](#documentation-1)
- [Architecture](#architecture)
- [Github](#github)
- [Github Repo](#github-repo)
- [Github Actions / Workflows](#github-actions--workflows)
- [Application](#application)
- [DevOps](#devops)
- [Github Page](#github-page)
- [Github Wiki](#github-wiki)
- [Comments](#comments)
- [Screenshots](#screenshots)
- [Authors and License](#authors-and-license)
- [License](#license)
- [MIT License](#mit-license)
- [Apache License](#apache-license)
- [Authors](#authors)
- [Code Contributors](#code-contributors)
# Description
Repo template with README-template and some Github workflows and Github actions.
### Features
- \[ ] advanced-super-extra-special feature xyz
- \[x] OSS and license
- \[x] works as designed
- \[ ] no bugs
- \[x] some more or less usefull Github Actions for GH-repo, GH-pages, GH-wiki, CI/CD-Pipelines
- \[ ] Packagemanager
- \[ ] Installation routine
- \[ ] portable application
- \[ ] runs on DOS/Windows
- \[ ] runs on MacOS
- \[ ] runs on Linux
- \[ ] runs on iOS
- \[ ] runs on Android
- \[ ] runs on HarmonyOS
# Status
:arrow_right: :warning: still under construction :warning: :arrow_left:
[](https://github.com/Zheng-Bote/repo-template/releases)
### Documentation
_see also:_ [Application Documentation](#documentation)
#### README
[](https://github.com/Zheng-Bote/repo-template/actions/workflows/repo-create_tree_readme.yml)
[](https://github.com/Zheng-Bote/repo-template/actions/workflows/repo-actions_docu.yml)
[](https://github.com/Zheng-Bote/repo-template/actions/workflows/repo-call_Readme.yml)
#### other Markdown files
[](https://github.com/Zheng-Bote/repo-template/actions/workflows/repo-create_doctoc_md.yml)
create ToC in Markdown files in folders
- .github/actions/\*\*
- .github/workflows/\*\*
- dist/\*\*
- docs/\*\*
# Installation
bla bla ... everything easy and green with No Code/Low code and without any costs
## Dependencies
bla bla ... with a little help from my friends
## folder structure
```
.
├── .github
│ ├── actions
│ │ └── doctoc
│ │ ├── README.md
│ │ ├── action.yml
│ │ └── dist
│ │ ├── index.js
│ │ ├── index.js.map
│ │ ├── licenses.txt
│ │ └── sourcemap-register.js
│ └── workflows
│ ├── ghp-call_Readme.yml
│ ├── ghp-create_doctoc.yml
│ ├── ghp-markdown_index.yml
│ ├── repo-actions_docu.yml
│ ├── repo-call_Readme.yml
│ ├── repo-create_doctoc.yml_
│ ├── repo-create_doctoc_md.yml
│ └── repo-create_tree_readme.yml
├── LICENSE
├── LICENSE_Apache-2
├── LICENSE_GPL-2
├── LICENSE_GPL-3
├── LICENSE_MIT
├── README.md
└── tree.bak
6 directories, 21 files
```
## Usage/Examples/Tests
bla bla ... usage is intuitive and runs mostly automatically with no needs of any knowledge
```HTML
under construction
```
# API Reference
_Inputs/Outputs will be filled automatically by `.github/workflows/repo-actions_docu.yml`_
## Inputs
## Outputs
## Parameters
**Workflow or program**
| Parameter | Type | Description |
| :----------- | :------- | :----------------------------------- |
| `name` | `string` | _Optional_ name-of-copyright-holder |
| `created` | `string` | _Optional_ |
| `version` | `string` | _Optional_ \ |
| `link_left` | `string` | _Optional_ link-to-contact-page |
| `link_right` | `string` | _Optional_ link-to-legal-notice-page |
# Documentation
see also:
## Architecture
### Github
#### Github Repo
```mermaid
block-beta
columns 4
Repo:4
block:group1:1
columns 1
id0[".github"]
block:group2:1
columns 1
id1[["workflows"]]
id2[["actions"]]
end
end
docs dist src
block:group3:4
%% columns auto (default)
A["gh-pages"] B["gh-wiki"]
end
```
#### Github Actions / Workflows
```mermaid
flowchart TD;
A[Workflow]-. parameter .->B[[callable Workflow]]
B-- parameter -->C[Action]
C-->D(README)
A[Workflow]-. parameter .->E[[callable Workflow]]
E-- parameter -->F[Action]
F-->J(Markdown files)
A[Workflow]-->K[[Workflow]]
K-->L[Action]
L-->M("GH-Pages")
A[Workflow]-->N[[Workflow]]
N-->O[Action]
O-->P("GH-Wiki")
```
## Application
```mermaid
architecture-beta
group api(cloud)[API]
service db(database)[Database] in api
service server0(server)[Webserver] in api
service disk2(disk)[Storage] in api
service server(server)[Appserver] in api
db:L -- R:server
server0:T -- B:server
disk2:T -- B:server
```
## DevOps
```mermaid
pie title me
"ideas" : 90
"time for realizations" : 7
"money for realizations" : 3
```
## Github Page
[](https://www.github.com/Zheng-Bote)
## Github Wiki
[](https://www.github.com/Zheng-Bote)
## Comments
> \[!NOTE]
> Useful information that users should know, even when skimming content.
> \[!TIP]
> Helpful advice for doing things better or more easily.
> \[!IMPORTANT]
> Key information users need to know to achieve their goal.
> \[!WARNING]
> Urgent info that needs immediate user attention to avoid problems.
> \[!CAUTION]
> Advises about risks or negative outcomes of certain actions.
## Screenshots
# Authors and License
## License
**This Repo-Template is using the MIT-License**
**_other licenses see files `LICENSE_`\_**
### MIT License
[](https://choosealicense.com/licenses/mit/)
Copyright (c) 2024 ZHENG Robert
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
https://choosealicense.com/licenses/mit/
### Apache License
[](<[https://choosealicense.com/licenses/mit/](http://www.apache.org/licenses/LICENSE-2.0)>)
Copyright (c) 2019 ZHENG Robert
Licensed under the **Apache License, Version 2.0** (the "License"); you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and limitations under the License.
## Authors
- [](https://www.github.com/Zheng-Bote)
### Code Contributors
[](https://www.github.com/Zheng-Bote)
:vulcan_salute: