Skip to content

Commit f6a5f49

Browse files
author
sgkens
committed
📝 docs: Update Documentation.
📜 NOTES: ✏ Added prod/dev stage switch in javascript:main.js and ruby:_config.yaml \ ✏ Updated bagdes - Added CodeFactor, psgal version, and choco version \
1 parent e707b59 commit f6a5f49

File tree

8 files changed

+151
-73
lines changed

8 files changed

+151
-73
lines changed

‎docs/Installation.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Import-Module -Name commitfusion
1717
Download the latest release from the [**Releases**](https://github.com/sgkens/commitfusion/releases) page.
1818
### 📦 Package Repositories
1919

20-
[<img src="https://img.shields.io/badge/psgal-v0.3.1-yellow?style=for-the-badge&logo=Powershell&labelColor=blue&color=gray"/>](https://www.powershellgallery.com/packages/commitfusion/0.4.3) <img src="https://img.shields.io/powershellgallery/dt/commitfusion?label=Downloads&style=for-the-badge">
20+
[<img src="https://img.shields.io/powershellgallery/v/commitfusion?include_prereleases&style=for-the-badge&logo=powershell"/>](https://www.powershellgallery.com/packages/commitfusion/0.4.3) <img src="https://img.shields.io/powershellgallery/dt/commitfusion?label=Downloads&style=for-the-badge">
2121

2222
```powershell
2323
# Install The Module from the PsGal
@@ -30,7 +30,7 @@ Import-Module -Name commitfusion
3030
> *Note!*
3131
> You may need to `Set-ExecutionPolicy` to `RemoteSigned` or `Unrestricted` to install from the PSGallary.
3232
33-
[<img src="https://img.shields.io/badge/Choco-v0.3.1-yellow?style=for-the-badge&logo=Chocolatey&labelColor=darkmagenta&color=gray"/>](https://Chocolatory.org/sgkens/commitfusion) <img src="https://img.shields.io/chocolatey/dt/commitfusion?label=Downloads&style=for-the-badge">
33+
[<img src="https://img.shields.io/chocolatey/v/commitfusion?style=for-the-badge&logo=chocolatey"/>](https://Chocolatory.org/sgkens/commitfusion) <img src="https://img.shields.io/chocolatey/dt/commitfusion?label=Downloads&style=for-the-badge">
3434

3535

3636
```powershell
@@ -46,5 +46,5 @@ Import-Module -Name commitfusion
4646

4747

4848
<div align="right">
49-
<a href="cmdlets"> Using Commitfusion's cmdlets </a>
49+
<a href="commitfusion/cmdlets"> Using Commitfusion's cmdlets </a>
5050
</div>

‎docs/_config.yml‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
repository: sgkens/slate-fusion
1+
repository: pages-themes/slate
22
#author: # [name, email, web]
33
remote_theme: pages-themes/slate@v0.2.0
44
title: [CommitFusion]
@@ -8,10 +8,12 @@ custom:
88
logo: 'https://raw.githubusercontent.com/sgkens/resources/main/modules/CommitFusion/dist/v2/logo-black-v2.svg'
99
dateupdated: 'Tuesday, 28 November 2023 8:26:40 PM'
1010
license: 'https://img.shields.io/badge/MIT-License-blue?style=flat&logo=unlicense&color=#36013f'
11-
version: 'https://img.shields.io/badge/version-v0.3.1-blue?style=flat&logo=Version&color=%23004481'
11+
version: 'https://img.shields.io/powershellgallery/v/commitfusion?include_prereleases&logo=powershell&label=Version&logoColor=white'
1212
choco: 'https://img.shields.io/chocolatey/dt/commitfusion?style=flat&logo=Chocolatey&labelColor=darkmagenta&color=gray'
1313
psgallary: 'https://img.shields.io/powershellgallery/dt/commitfusion?style=flat&logo=powershell&labelColor=blue&color=gray'
14-
14+
codefactor: 'https://www.codefactor.io/repository/github/sgkens/commitfusion/badge'
15+
prod: '/commitfusion' # Dev / github pages /reponame
16+
# dev: '/'
1517

1618
#google_analytics: [Your Google Analytics tracking ID]
1719
plugins:

‎docs/_includes/menu.html‎

Lines changed: 20 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,20 @@
1-
<div id ="menu" class="menu">
2-
<a href="/"><button id="about" class="button-29" role="button">About</button></a>
3-
<a href="/features"><button id="features" class="button-29" role="button">Features</button></a>
4-
<a href="installation"><button id="installation" class="button-29" role="button">Installation</button></a>
5-
<a href="cmdlets"><button id="cmdlets" class="button-29" role="button">Cmdlets</button></a>
6-
<a href="examples"><button id="examples" class="button-29" role="button">Examples</button></a>
7-
</div>
8-
1+
<div id ="menu" class="menu">
2+
3+
{% if site.custom.prod %}
4+
<a href="{{ site.custom.prod }}"><button id="about" class="button-29" role="button">About</button></a>
5+
<a href="{{ site.custom.prod }}/features"><button id="features" class="button-29" role="button">Features</button></a>
6+
<a href="{{ site.custom.prod }}/installation"><button id="installation" class="button-29" role="button">Installation</button></a>
7+
<a href="{{ site.custom.prod }}/cmdlets"><button id="cmdlets" class="button-29" role="button">Cmdlets</button></a>
8+
<a href="{{ site.custom.prod }}/examples"><button id="examples" class="button-29" role="button">Examples</button></a>
9+
{% endif %}
10+
11+
{% if site.custom.dev %}
12+
<a href="/"><button id="about" class="button-29" role="button">About</button></a>
13+
<a href="/features"><button id="features" class="button-29" role="button">Features</button></a>
14+
<a href="/installation"><button id="installation" class="button-29" role="button">Installation</button></a>
15+
<a href="/cmdlets"><button id="cmdlets" class="button-29" role="button">Cmdlets</button></a>
16+
<a href="/examples"><button id="examples" class="button-29" role="button">Examples</button></a>
17+
{% endif %}
18+
19+
</div>
20+

‎docs/_layouts/default.html‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -92,6 +92,9 @@ <h2 id="project_tagline">{{ site.description | default: site.github.project_tagl
9292
<a href="https://github.com/sgkens/commitfusion/">
9393
<img src="{{ site.custom.version }}">
9494
</a>
95+
<a href="https://www.codefactor.io/repository/github/sgkens/commitfusion/">
96+
<img src="{{ site.custom.codefactor }}">
97+
</a>
9598
<a href="https://psgallary.com/sgkens/commitfusion/">
9699
<img src="{{ site.custom.psgallary }}">
97100
</a>

‎docs/assets/js/main.js‎

Lines changed: 40 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,9 @@ window.onload = function() {
2020
// },
2121
// });
2222

23+
// Development
24+
var development = false
25+
2326
// Get all details elements
2427
const detailsElements = document.querySelectorAll(".accordion details");
2528
let typed1;
@@ -434,7 +437,7 @@ window.onload = function() {
434437
});
435438

436439
var menu = document.getElementById("menu");
437-
if (menu) {
440+
if (menu && development === true) {
438441
switch (document.location.pathname) {
439442
case "/":
440443
console.log("Nav to Index");
@@ -448,7 +451,9 @@ window.onload = function() {
448451

449452
case "/installation":
450453
console.log("Nav to Installation");
451-
document.getElementById("installation").classList.add("button-page-active");
454+
document
455+
.getElementById("installation")
456+
.classList.add("button-page-active");
452457
break;
453458

454459
case "/cmdlets":
@@ -465,6 +470,39 @@ window.onload = function() {
465470
console.log("Nav to features");
466471
}
467472
}
473+
else{
474+
switch (document.location.pathname) {
475+
case "/commitfusion":
476+
console.log("Nav to Index");
477+
document.getElementById("about").classList.add("button-page-active");
478+
break;
479+
480+
case "/commitfusion/features":
481+
console.log("Nav to features");
482+
document.getElementById("features").classList.add("button-page-active");
483+
break;
484+
485+
case "/commitfusion/installation":
486+
console.log("Nav to Installation");
487+
document
488+
.getElementById("installation")
489+
.classList.add("button-page-active");
490+
break;
491+
492+
case "/commitfusion/cmdlets":
493+
console.log("Nav to cmdlets");
494+
document.getElementById("cmdlets").classList.add("button-page-active");
495+
break;
496+
497+
case "/commitfusion/examples":
498+
console.log("Nav to examples");
499+
document.getElementById("examples").classList.add("button-page-active");
500+
break;
501+
502+
default:
503+
console.log("Nav to features");
504+
}
505+
}
468506
}
469507

470508

‎docs/cmdlets.md‎

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ Commitfusion provides a number cmdlets to help with the creation of conventional
2828
2929
2. **Scope** `[string]` The Scope of the commit, User specified, placed between brackets after the `Type` - <span style="color:green;">OPTIONAL</span>
3030
3. **Description** `[string]` The Commit Description, User specified, placed after the `scope` - <span style="color:magenta;">PARAMERTER REQUIRED</span>
31-
4. **Body** `[string[]]` Array of text and will ouput under the `NOTES:` area inside the body - <span style="color:green;">OPTIONAL</span>
31+
4. **Notes** `[string[]]` Array of text and will ouput under the `NOTES:` area inside the body - <span style="color:green;">OPTIONAL</span>
3232
5. **BugFixes** `[string[]]` Array of text and will ouput under the `BUG FIXES:` area inside the body - <span style="color:green;">OPTIONAL</span>
3333
6. **FeatureNotes** `[string[]]` Array of text and will ouput under the `FEATURE NOTES:` area inside the body, - <span style="color:green;">OPTIONAL</span>
3434
7. **FeatureAddtions** `[string[]]` Array of text and will ouput under the `FEATURE ADDTIONS:` area inside the body - <span style="color:green;">OPTIONAL</span>
@@ -48,7 +48,7 @@ New-Commit -Type feat -Description "Added new feature"
4848
New-Commit -Type feat `
4949
-Description "Added new feature" `
5050
-Scope "add" `
51-
-Body "Note 1","Note 2" `
51+
-Notes "Note 1","Note 2" `
5252
-BugFixes "BugFixes 1","BugFixes 2" `
5353
-FeatureNotes "FeatureNotes 1","FeatureNotes 2" `
5454
-FeatureAddtions "FeatureAddtions 1","FeatureAddtions 2" `
@@ -109,7 +109,7 @@ The function currently takes `0` parameters. It reads the output from `New-Commi
109109
New-Commit -Type feat `
110110
-Description "Added new feature" `
111111
-Scope "add" `
112-
-Body "Note 1","Note 2" `
112+
-Notes "Note 1","Note 2" `
113113
-BugFixes "BugFixes 1","BugFixes 2" `
114114
-FeatureNotes "FeatureNotes 1","FeatureNotes 2" `
115115
-FeatureAddtions "FeatureAddtions 1","FeatureAddtions 2" `
@@ -177,7 +177,7 @@ New-Commit -Type feat `
177177
New-Commit New-Commit -Type feat `
178178
-Description "Added new feature" `
179179
-Scope "add" `
180-
-Body "Note 1","Note 2" `
180+
-Notes "Note 1","Note 2" `
181181
-BugFixes "BugFixes 1","BugFixes 2" `
182182
-FeatureNotes "FeatureNotes 1","FeatureNotes 2" `
183183
-FeatureAddtions "FeatureAddtions 1","FeatureAddtions 2" `
@@ -202,6 +202,7 @@ This function takes `0` **Parameters**, it will parse the git log see [**semver-
202202
git log with no `semver` tags in the git log
203203

204204
```powershell
205+
# Object
205206
Get-GitAutoVersion
206207
207208
# just property
@@ -214,9 +215,17 @@ Get-GitAutoVersion | Select-Object -Property Version
214215
> #### *Will Ouput*
215216
216217
```bash
218+
# object
217219
Version Parsedlines
218220
------- -----------
219221
0.1.0 3
222+
223+
# string
224+
0.1.0
225+
226+
# string
227+
0.1.0
228+
220229
```
221230
<a href="/cmdlets#toc"><i class="fa-solid fa-circle-up"></i></a>
222231

@@ -319,4 +328,4 @@ Get-CiSetFusion -NoSemver -NoRender | Select-Object -First 10 | FT -Wrap
319328
## Get-CommitFusionModuleInstance
320329
**Get-CommitFusionModuleInstance** takes `0` Parameters and will return the module instance initiated at module import. See `$moduleroot/libs/cmdlets/Get-CommitFusionModuleInstance.psm1`, used by all the cmdlets to interact with the class instance.
321330

322-
<a href="/cmdlets#toc"><i class="fa-solid fa-circle-up"></i></a>
331+
<a href="commitfusion/cmdlets#toc"><i class="fa-solid fa-circle-up"></i></a>

0 commit comments

Comments
 (0)