Table of Contents
Repo template with README-template and some Github workflows and Github actions.
-
advanced-super-extra-special feature xyz
-
OSS and license
-
works as designed
-
no bugs
- 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
see also: Application Documentation
create ToC in Markdown files in folders
- .github/actions/**
- .github/workflows/**
- dist/**
- docs/**
bla bla ... everything easy and green with No Code/Low code and without any costs
bla bla ... with a little help from my friends
.
├── .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
5 directories, 21 files
bla bla ... usage is intuitive and runs mostly automatically with no needs of any knowledge
<mark> under construction </mark>Inputs/Outputs will be filled automatically by .github/workflows/repo-actions_docu.yml
Workflow or program
| Parameter | Type | Description |
|---|---|---|
name |
string |
Optional name-of-copyright-holder |
created |
string |
Optional |
version |
string |
Optional <v0.0.0> |
link_left |
string |
Optional link-to-contact-page |
link_right |
string |
Optional link-to-legal-notice-page |
see also: https://linktodocumentation
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
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")
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
pie title me
"ideas" : 90
"time for realizations" : 7
"money for realizations" : 3
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.
This Repo-Template is using the MIT-License
_other licenses see files LICENSE_<name>_
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/
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.
🖖