Skip to content

Commit 5260b8d

Browse files
author
ADMSK\AVROGAL1
committed
docs: updates on workflows
Added information on documentation
2 parents 9fdf22c + d81ae8a commit 5260b8d

File tree

2 files changed

+38
-28
lines changed

2 files changed

+38
-28
lines changed

README.md

Lines changed: 37 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
[![Reviewed by Hound](https://img.shields.io/badge/Reviewed_by-Hound-8E64B0.svg)](https://houndci.com)
1111
[![Chat](https://img.shields.io/badge/chat-discussions-success.svg)](https://github.com/AlexRogalskiy/github-action-json-fields/discussions)
1212

13-
[![DeepScan grade](https://deepscan.io/api/teams/11946/projects/16314/branches/347248/badge/grade.svg)](https://deepscan.io/dashboard#view=project\&tid=11946\&pid=16314\&bid=347248)
13+
[![DeepScan grade](https://deepscan.io/api/teams/11946/projects/16314/branches/347248/badge/grade.svg)](https://deepscan.io/dashboard#view=project&tid=11946&pid=16314&bid=347248)
1414
![GitHub tag (latest by date)](https://img.shields.io/github/v/tag/AlexRogalskiy/github-action-json-fields)
1515
![GitHub Release Date](https://img.shields.io/github/release-date/AlexRogalskiy/github-action-json-fields)
1616
![Lines of code](https://tokei.rs/b1/github/AlexRogalskiy/github-action-json-fields?category=lines)
@@ -42,26 +42,36 @@
4242

4343
## *Table of contents*
4444

45-
- [*Description*](#description)
46-
- [*Inputs*](#inputs)
47-
- [`sourceData`](#sourcedata)
48-
- [`mode`](#mode)
49-
- [`jsonPath`](#jsonpath)
50-
- [`jsonFields`](#jsonfields)
51-
- [`sourceFile`](#sourcefile)
52-
- [`targetPath`](#targetpath)
53-
- [`targetFile`](#targetfile)
54-
- [*Outputs*](#outputs)
55-
- [`changed`](#changed)
56-
- [*Examples*](#examples)
57-
- [*Visitor stats*](#visitor-stats)
58-
- [*Licensing*](#licensing)
59-
- [*Authors*](#authors)
60-
- [*Versioning*](#versioning)
61-
- [*Contribution*](#contribution)
62-
- [*Acknowledgement*](#acknowledgement)
63-
- [*Forks*](#forks)
64-
- [*Development Support*](#development-support)
45+
<!--ts-->
46+
* [<em>Json fields</em>](#json-fields)
47+
* [<em>Table of contents</em>](#table-of-contents)
48+
* [<em>Description</em>](#description)
49+
* [<em>Inputs</em>](#inputs)
50+
* [sourceData](#sourcedata)
51+
* [Complete parameters](#complete-parameters)
52+
* [Basic parameters](#basic-parameters)
53+
* [mode](#mode)
54+
* [unique](#unique)
55+
* [duplicate](#duplicate)
56+
* [jsonPath](#jsonpath)
57+
* [jsonFields](#jsonfields)
58+
* [sourceFile](#sourcefile)
59+
* [targetPath](#targetpath)
60+
* [targetFile](#targetfile)
61+
* [<em>Outputs</em>](#outputs)
62+
* [changed](#changed)
63+
* [true](#true)
64+
* [false](#false)
65+
* [<em>Examples</em>](#examples)
66+
* [<em>Visitor stats</em>](#visitor-stats)
67+
* [<em>Licensing</em>](#licensing)
68+
* [<em>Authors</em>](#authors)
69+
* [<em>Versioning</em>](#versioning)
70+
* [<em>Contribution</em>](#contribution)
71+
* [<em>Acknowledgement</em>](#acknowledgement)
72+
* [<em>Forks</em>](#forks)
73+
* [<em>Development Support</em>](#development-support)
74+
<!--te-->
6575

6676
## *Description*
6777

@@ -208,7 +218,7 @@ Running locally:
208218

209219
## *Visitor stats*
210220

211-
[![GitHub page hits](https://hits.seeyoufarm.com/api/count/incr/badge.svg?url=https%3A%2F%2Fgithub.com%2FAlexRogalskiy%2Fgithub-action-json-fields\&count_bg=%2379C83D\&title_bg=%23555555\&icon=\&icon_color=%23E7E7E7\&title=hits\&edge_flat=true)](https://hits.seeyoufarm.com)
221+
[![GitHub page hits](https://hits.seeyoufarm.com/api/count/incr/badge.svg?url=https%3A%2F%2Fgithub.com%2FAlexRogalskiy%2Fgithub-action-json-fields&count_bg=%2379C83D&title_bg=%23555555&icon=&icon_color=%23E7E7E7&title=hits&edge_flat=true)](https://hits.seeyoufarm.com)
212222

213223
![GitHub stars](https://img.shields.io/github/stars/AlexRogalskiy/github-action-json-fields?style=social)
214224
![GitHub forks](https://img.shields.io/github/forks/AlexRogalskiy/github-action-json-fields?style=social)
@@ -237,7 +247,7 @@ this repository][tags].
237247

238248
## *Contribution*
239249

240-
[![Contributors Display](https://badges.pufler.dev/contributors/AlexRogalskiy/github-action-json-fields?size=50\&padding=5\&bots=true)](https://badges.pufler.dev)
250+
[![Contributors Display](https://badges.pufler.dev/contributors/AlexRogalskiy/github-action-json-fields?size=50&padding=5&bots=true)](https://badges.pufler.dev)
241251

242252
Please read
243253
[CONTRIBUTING.md](https://github.com/AlexRogalskiy/github-action-json-fields/blob/master/.github/CONTRIBUTING.md)
@@ -264,15 +274,15 @@ See also the list of [contributors][contributors] who participated in this proje
264274

265275
Like ***Json Fields*** ? Consider buying me a coffee :)
266276

267-
[![Become a Patron](https://img.shields.io/badge/Become_Patron-Support_me_on_Patreon-blue.svg?style=flat-square\&logo=patreon\&color=e64413)](https://www.patreon.com/alexrogalskiy)
277+
[![Become a Patron](https://img.shields.io/badge/Become_Patron-Support_me_on_Patreon-blue.svg?style=flat-square&logo=patreon&color=e64413)](https://www.patreon.com/alexrogalskiy)
268278
[![Buy Me A Coffee](https://img.shields.io/badge/Donate-Buy%20me%20a%20coffee-yellow.svg?logo=buy%20me%20a%20coffee)](https://www.buymeacoffee.com/AlexRogalskiy)
269279
[![KoFi](https://img.shields.io/badge/Donate-Buy%20me%20a%20coffee-yellow.svg?logo=ko-fi)](https://ko-fi.com/alexrogalskiy)
270280

271281
***
272282

273-
[![forthebadge](https://img.shields.io/badge/made%20with-%20typescript-C1282D.svg?logo=typescript\&style=for-the-badge)](https://www.typescriptlang.org/)
274-
[![forthebadge](https://img.shields.io/badge/powered%20by-%20github-7116FB.svg?logo=github\&style=for-the-badge)](https://github.com/)
275-
[![forthebadge](https://img.shields.io/badge/build%20with-%20%E2%9D%A4-B6FF9B.svg?logo=heart\&style=for-the-badge)](https://forthebadge.com/)
283+
[![forthebadge](https://img.shields.io/badge/made%20with-%20typescript-C1282D.svg?logo=typescript&style=for-the-badge)](https://www.typescriptlang.org/)
284+
[![forthebadge](https://img.shields.io/badge/powered%20by-%20github-7116FB.svg?logo=github&style=for-the-badge)](https://github.com/)
285+
[![forthebadge](https://img.shields.io/badge/build%20with-%20%E2%9D%A4-B6FF9B.svg?logo=heart&style=for-the-badge)](https://forthebadge.com/)
276286

277287
[repo]: https://github.com/AlexRogalskiy/github-action-json-fields
278288

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@
4141
"test:watch": "env-cmd --silent -e test jest --watch",
4242
"test:license": "license-checker --production --summary --unknown --onlyAllow=\"Apache-2.0;BSD;ISC;MIT;UNLICENSED;\"",
4343
"lint:all": "npm run lint:clean && npm run lint && npm run lint:md && npm run lint:json",
44-
"format:all": "npm run format && npm run format:md",
44+
"format:all": "npm run format",
4545
"check:all": "npm run format:check",
4646
"test:all": "npm run test && npm run test:folio && npm run test:license",
4747
"all": "npm run format:all && npm run lint:all && npm run pretty && npm run build"

0 commit comments

Comments
 (0)