Skip to content

Commit e233a71

Browse files
kzukzu
committed
📝 Improve rendering on nuget.org by moving table
Place the table at the end, since it doesn't look great as a first impression.
1 parent b133e39 commit e233a71

File tree

3 files changed

+27
-33
lines changed

3 files changed

+27
-33
lines changed

‎readme.md

Lines changed: 9 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -22,14 +22,13 @@ Usage:
2222
</JsonPeek>
2323
```
2424

25-
2625
Parameters:
2726

2827
| Parameter | Description |
2928
| ----------- | -------------------------------------------------------------------------------------------------------------- |
3029
| Content | Optional `string` parameter. Input/Output.<br/>Specifies the JSON input as a string. |
31-
| ContentPath | Optional `ITaskItem` parameter.<br/>Specifies the JSON input as a file path. |
32-
| Query | Required `string` parameter.<br/>Specifies the [JSONPath](https://goessner.net/articles/JsonPath/) expression. |
30+
| ContentPath | Optional `ITaskItem` parameter.<br/>Specifies the JSON input as a file path. |
31+
| Query | Required `string` parameter.<br/>Specifies the [JSONPath](https://goessner.net/articles/JsonPath/) expression. |
3332
| Result | Output `ITaskItem[]` parameter.<br/>Contains the results that are returned by the task. |
3433

3534
You can either provide the path to a JSON file via `ContentPath` or
@@ -100,13 +99,13 @@ Usage:
10099

101100
Parameters:
102101

103-
| Parameter | Description |
104-
| ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ |
105-
| Content | Optional `string` input/output parameter.<br/>Specifies the JSON input as a string and contains the updated <br/>JSON after successful task execution. |
106-
| ContentPath | Optional `ITaskItem` parameter.<br/>Specifies the JSON input as a file path. |
107-
| Query | Required `string` parameter.<br/>Specifies the [JSONPath](https://goessner.net/articles/JsonPath/) expression. |
108-
| Value | Optional `ITaskItem[]` parameter.<br/>Specifies the value(s) to be inserted into the specified path. |
109-
| RawValue | Optional `string` parameter.<br/>Specifies the raw (JSON) value to be inserted into the specified path. |
102+
| Parameter | Description |
103+
| ----------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |
104+
| Content | Optional `string` input/output parameter.<br/>Specifies the JSON input as a string and contains the updated<br/>JSON after successful task execution. |
105+
| ContentPath | Optional `ITaskItem` parameter.<br/>Specifies the JSON input as a file path. |
106+
| Query | Required `string` parameter.<br/>Specifies the [JSONPath](https://goessner.net/articles/JsonPath/) expression. |
107+
| Value | Optional `ITaskItem[]` parameter.<br/>Specifies the value(s) to be inserted into the specified path. |
108+
| RawValue | Optional `string` parameter.<br/>Specifies the raw (JSON) value to be inserted into the specified path. |
110109

111110
You must either provide the path to a JSON file via `ContentPath` or
112111
raw JSON content via `Content`.
@@ -236,7 +235,6 @@ The modified JSON nodes can be assigned to an item name using the `Result` task
236235
and will contain the item path (matching the `Query` plus the index if multiple nodes were modified)
237236
as well as the `Value` item metadata containing the raw JSON that was written.
238237

239-
240238
# Dogfooding
241239

242240
[![CI Version](https://img.shields.io/endpoint?url=https://shields.kzu.io/vpre/JsonPeek/main&label=nuget.ci&color=brightgreen)](https://pkg.kzu.io/index.json)
@@ -251,8 +249,6 @@ The versioning scheme for packages is:
251249
- PR builds: *42.42.42-pr*`[NUMBER]`
252250
- Branch builds: *42.42.42-*`[BRANCH]`.`[COMMITS]`
253251

254-
255-
256252
## Sponsors
257253

258254
[![sponsored](https://raw.githubusercontent.com/devlooped/oss/main/assets/images/sponsors.svg)](https://github.com/sponsors/devlooped) [![clarius](https://raw.githubusercontent.com/clarius/branding/main/logo/byclarius.svg)](https://github.com/clarius)[![clarius](https://raw.githubusercontent.com/clarius/branding/main/logo/logo.svg)](https://github.com/clarius)

‎src/JsonPeek/readme.md

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -14,16 +14,6 @@ Usage:
1414
</JsonPeek>
1515
```
1616

17-
18-
Parameters:
19-
20-
| Parameter | Description |
21-
| ----------- | -------------------------------------------------------------------------------------------------------------- |
22-
| Content | Optional `string` parameter. Input/Output.<br/>Specifies the JSON input as a string. |
23-
| ContentPath | Optional `ITaskItem` parameter.<br/>Specifies the JSON input as a file path. |
24-
| Query | Required `string` parameter.<br/>Specifies the [JSONPath](https://goessner.net/articles/JsonPath/) expression. |
25-
| Result | Output `ITaskItem[]` parameter.<br/>Contains the results that are returned by the task. |
26-
2717
You can either provide the path to a JSON file via `ContentPath` or
2818
provide the straight JSON content to `Content`. The `Query` is a
2919
[JSONPath](https://goessner.net/articles/JsonPath/) expression that is evaluated
@@ -75,6 +65,14 @@ These item metadata values could be read as MSBuild properties as follows, for e
7565
</PropertyGroup>
7666
```
7767

68+
## Parameters
69+
70+
| Parameter | Description |
71+
| ----------- | -------------------------------------------------------------------------------------------------------------- |
72+
| Content | Optional `string` parameter.<br/>Specifies the JSON input as a string. |
73+
| ContentPath | Optional `ITaskItem` parameter.<br/>Specifies the JSON input as a file path. |
74+
| Query | Required `string` parameter.<br/>Specifies the [JSONPath](https://goessner.net/articles/JsonPath/) expression. |
75+
| Result | Output `ITaskItem[]` parameter.<br/>Contains the results that are returned by the task. |
7876

7977
## Sponsors
8078

‎src/JsonPoke/readme.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -11,16 +11,6 @@ Usage:
1111
<JsonPoke Content="[JSON]" Query="[JSONPath]" Value="[VALUE]" />
1212
```
1313

14-
Parameters:
15-
16-
| Parameter | Description |
17-
| ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ |
18-
| Content | Optional `string` input/output parameter.<br/>Specifies the JSON input as a string and contains the updated <br/>JSON after successful task execution. |
19-
| ContentPath | Optional `ITaskItem` parameter.<br/>Specifies the JSON input as a file path. |
20-
| Query | Required `string` parameter.<br/>Specifies the [JSONPath](https://goessner.net/articles/JsonPath/) expression. |
21-
| Value | Optional `ITaskItem[]` parameter.<br/>Specifies the value(s) to be inserted into the specified path. |
22-
| RawValue | Optional `string` parameter.<br/>Specifies the raw (JSON) value to be inserted into the specified path. |
23-
2414
You must either provide the path to a JSON file via `ContentPath` or
2515
raw JSON content via `Content`.
2616

@@ -149,6 +139,16 @@ The modified JSON nodes can be assigned to an item name using the `Result` task
149139
and will contain the item path (matching the `Query` plus the index if multiple nodes were modified)
150140
as well as the `Value` item metadata containing the raw JSON that was written.
151141

142+
## Parameters
143+
144+
| Parameter | Description |
145+
| ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ |
146+
| Content | Optional `string` input/output parameter.<br/>Specifies the JSON input as a string and contains the updated <br/>JSON after successful task execution. |
147+
| ContentPath | Optional `ITaskItem` parameter.<br/>Specifies the JSON input as a file path. |
148+
| Query | Required `string` parameter.<br/>Specifies the [JSONPath](https://goessner.net/articles/JsonPath/) expression. |
149+
| Value | Optional `ITaskItem[]` parameter.<br/>Specifies the value(s) to be inserted into the specified path. |
150+
| RawValue | Optional `string` parameter.<br/>Specifies the raw (JSON) value to be inserted into the specified path. |
151+
152152
## Sponsors
153153

154154
[![sponsored](https://raw.githubusercontent.com/devlooped/oss/main/assets/images/sponsors.svg)](https://github.com/sponsors/devlooped) [![clarius](https://raw.githubusercontent.com/clarius/branding/main/logo/byclarius.svg)](https://github.com/clarius)[![clarius](https://raw.githubusercontent.com/clarius/branding/main/logo/logo.svg)](https://github.com/clarius)

0 commit comments

Comments
 (0)