Skip to content

Commit

Permalink
📝 Improve rendering on nuget.org by moving table
Browse files Browse the repository at this point in the history 
Place the table at the end, since it doesn't look great as a first impression.
  • Loading branch information
@kzu
kzu committed Sep 15, 2021
1 parent b133e39 commit e233a71
Show file tree
Hide file tree
Showing 3 changed files with 27 additions and 33 deletions.
22 changes: 9 additions & 13 deletions readme.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,14 +22,13 @@ Usage:
</JsonPeek>
```


Parameters:

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

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

Parameters:

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

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


# Dogfooding

[![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)
Expand All @@ -251,8 +249,6 @@ The versioning scheme for packages is:
- PR builds: *42.42.42-pr*`[NUMBER]`
- Branch builds: *42.42.42-*`[BRANCH]`.`[COMMITS]`



## Sponsors

[![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)
Expand Down
18 changes: 8 additions & 10 deletions src/JsonPeek/readme.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,16 +14,6 @@ Usage:
</JsonPeek>
```


Parameters:

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

You can either provide the path to a JSON file via `ContentPath` or
provide the straight JSON content to `Content`. The `Query` is a
[JSONPath](https://goessner.net/articles/JsonPath/) expression that is evaluated
Expand Down Expand Up @@ -75,6 +65,14 @@ These item metadata values could be read as MSBuild properties as follows, for e
</PropertyGroup>
```

## Parameters

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

## Sponsors

Expand Down
20 changes: 10 additions & 10 deletions src/JsonPoke/readme.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,16 +11,6 @@ Usage:
<JsonPoke Content="[JSON]" Query="[JSONPath]" Value="[VALUE]" />
```

Parameters:

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

You must either provide the path to a JSON file via `ContentPath` or
raw JSON content via `Content`.

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

## Parameters

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

## Sponsors

[![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)
Expand Down

0 comments on commit e233a71

Please sign in to comment.