Skip to content

Commit 99c7205

Browse files
gregsdennisgregsdennis
committed
docs reorganization; more progress
1 parent e314743 commit 99c7205

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

70 files changed

+303
-303
lines changed

‎_config.yml

+1-29
Original file line numberDiff line numberDiff line change
@@ -142,36 +142,17 @@ kramdown:
142142
start_line: 1
143143

144144
collections:
145-
tabs:
146-
output: true
147-
sort_by: order
148145
docs:
149146
output: true
150147
sort_by: order
151148

152149
defaults:
153-
- scope:
154-
path: "" # An empty string here means all files in the project
155-
type: posts
156-
values:
157-
layout: post
158-
comments: true # Enable comments in posts.
159-
toc: true # Display TOC column in posts.
160-
# DO NOT modify the following parameter unless you are confident enough
161-
# to update the code of all other post links in this project.
162-
permalink: /posts/:title/
163-
- scope:
164-
path: ""
165-
type: tabs # see `site.collections`
166-
values:
167-
layout: page
168-
permalink: /:title/
169150
- scope:
170151
path: ""
171152
type: docs # see `site.collections`
172153
values:
173154
layout: page
174-
permalink: /:title/
155+
permalink: /:name/
175156
toc: true
176157
- scope:
177158
path: assets/img/favicons
@@ -204,12 +185,3 @@ exclude:
204185
- rollup.config.js
205186
- node_modules
206187
- package*.json
207-
208-
jekyll-archives:
209-
enabled: [categories, tags]
210-
layouts:
211-
# category: category
212-
tag: tag
213-
permalinks:
214-
tag: /tags/:name/
215-
# category: /categories/:name/

‎_docs/jsonschema.net/examples/close.md

-4
This file was deleted.

‎_docs/jsonschema.net/title.md

-5
This file was deleted.

‎_docs/jsonschema.net/vocabs/close.md

-4
This file was deleted.

‎_docs/logic/json-logic.md renamed to ‎_docs/logic/basics.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
---
22
layout: page
33
title: JsonLogic Basics
4-
bookmark: JsonLogic
4+
md_title: _JsonLogic_ Basics
5+
bookmark: JSON Logic
6+
permalink: /logic/:title/
57
icon: fas fa-tag
68
order: "5.1"
79
---

‎_docs/more/close.md

+1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
---
2+
permalink: /more/:title/
23
close: true
34
order: "6.9"
45
---

‎_docs/more/examples/close.md

+1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
---
2+
permalink: /more/examples/:title/
23
close: true
34
order: "6.9"
45
---

‎_docs/more/examples/enums.md

+1
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
layout: page
33
title: Serializing Enumerations by Name
44
bookmark: Enum Serialization
5+
permalink: /more/examples/:title/
56
icon: fas fa-tag
67
order: "6.2.1"
78
---

‎_docs/more/examples/title.md

+1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
bookmark: Examples
3+
permalink: /more/examples/:title/
34
folder: true
45
order: "6.2"
56
---

‎_docs/more/json-more.md

+2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
---
22
layout: page
33
title: Json.More.Net Basics
4+
md_title: _Json.More.Net_ Basics
45
bookmark: Basics
6+
permalink: /more/:title/
57
icon: fas fa-tag
68
order: "6.1"
79
---

‎_docs/more/title.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
2-
bookmark: Json.More.Net
2+
bookmark: More JSON Support
3+
permalink: /more/:title/
34
folder: true
45
order: "6"
56
---

‎_docs/patch/json-patch.md renamed to ‎_docs/patch/basics.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
---
22
layout: page
33
title: JsonPatch.Net Basics
4-
bookmark: JsonPatch.Net
4+
md_title: _JsonPatch.Net_ Basics
5+
bookmark: JSON Patch
6+
permalink: /patch/:title/
57
icon: fas fa-tag
68
order: "3.1"
79
---

‎_docs/path/json-path.md renamed to ‎_docs/path/basics.md

+9-7
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,17 @@
11
---
22
layout: page
33
title: JsonPath.Net Basics
4-
bookmark: JsonPath.Net
4+
md_title: _JsonPath.Net_ Basics
5+
bookmark: JSON Path
6+
permalink: /path/:title/
57
icon: fas fa-tag
68
order: "2.1"
79
---
8-
JSON Path is a query language for JSON documents inspired by what XPath provides for XML documents. It was [originally proposed](https://goessner.net/articles/JsonPath/) by Matt Goessner, and now a [specification](https://github.com/jsonpath-standard/internet-draft) is in progress.
10+
JSON Path is a query language for JSON documents inspired by what XPath provides for XML documents. It was [originally proposed](https://goessner.net/articles/JsonPath/) by Matt Goëssner, and now a [specification](https://github.com/jsonpath-standard/internet-draft) is in progress.
911

1012
Version 0.4.x is aligned with the specification as of the end of Feb 2023, including support for functions (recently merged) and arithmetic operations in expressions (not part of the spec yet).
1113

12-
# Syntax {#path-syntax}
14+
## Syntax {#path-syntax}
1315

1416
A path consists of start indicator followed by a series of segments, chained one after another. Each segment contains one or more selectors. Each selector takes in a collection of JSON nodes and produces a collection of JSON nodes (called a "nodelist") based on their function. The output of the segment is the collective output of all of that segment's selectors. Each segment takes as input the output of the previous selector.
1517

@@ -32,7 +34,7 @@ In addition to the above, there are a few shorthand options for some special cas
3234
- `..['foo']` may be rewritten as `..foo`
3335
- `..[*]` may be rewritten as `..*`
3436

35-
## Query Expressions {#path-expressions}
37+
### Query Expressions {#path-expressions}
3638

3739
Filter selectors take an expression. This expression uses a single variable, which is a JSON node as described above. The node is denoted by `@` and any valid JSON Path can follow it. The `@` is a stand-in for the `$` from above and acts as the root of the local value.
3840

@@ -65,7 +67,7 @@ Expressions support the following operations:
6567
> Arithmetic operations are not part of the specification (yet), and cannot be expected to work in other JSON Path implementations.
6668
{: .prompt-info }
6769

68-
### Functions {#path-functions}
70+
#### Functions {#path-functions}
6971

7072
There is also support for functions within query expressions, which works as an extension point to add your own custom logic.
7173

@@ -109,7 +111,7 @@ Now that your function class is created, all that's left is to register it:
109111
FunctionRepository.Register(new MyCustomFunc());
110112
```
111113

112-
# In Code {#path-in-code}
114+
## In Code {#path-in-code}
113115

114116
To obtain an instance of a JSON Path, you'll need to parse it from a string.
115117

@@ -137,7 +139,7 @@ This will return a results object that contains the resulting nodelist or an err
137139

138140
A node contains both the value that was found and the location in the instance _where_ it was found. The location is always represented using the "canonical," bracketed format.
139141

140-
# Adherence to the Proposed Specification {#path-spec}
142+
## Adherence to the Proposed Specification {#path-spec}
141143

142144
As the specification is still under authorship, there are features present in traditional JSON Path that haven't been properly described yet. For these features, this library has been configured to mimic the consensus behaviors of other libraries as determined by the [JSON Path Comparison](https://cburgmer.github.io/json-path-comparison/) project.
143145

‎_docs/pointer/json-pointer.md renamed to ‎_docs/pointer/basics.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
---
22
layout: page
33
title: JsonPointer.Net Basics
4-
bookmark: JsonPointer.Net
4+
md_title: _JsonPointer.Net_ Basics
5+
bookmark: JSON Pointer
6+
permalink: /pointer/:title/
57
icon: fas fa-tag
68
order: "4.1"
79
---

‎_docs/jsonschema.net/close.md renamed to ‎_docs/release-notes/close.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
---
22
close: true
3-
order: "1.9"
3+
order: "8.9"
44
---

‎_docs/release-notes/json-logic.md renamed to ‎_docs/release-notes/rn-json-logic.md

+7-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
layout: page
3+
title: JsonLogic.Net
4+
icon: fas fa-tag
5+
order: "8.10"
6+
---
17
# [4.0.4](https://github.com/gregsdennis/json-everything/pull/422) {#release-logic-4.0.4}
28

39
[#420](https://github.com/gregsdennis/json-everything/issues/404) - `<=` not working for the "between" case. Thanks to [@alexkharuk](https://github.com/alexkharuk) for finding and fixing this issue.
@@ -119,4 +125,4 @@ Signed the DLL for strong name compatibility.
119125

120126
# 1.0.0 {#release-logic-1.0.0}
121127

122-
Initial release.
128+
Initial release.

‎_docs/release-notes/json-more.md renamed to ‎_docs/release-notes/rn-json-more.md

+7-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
layout: page
3+
title: Json.More.Net
4+
icon: fas fa-tag
5+
order: "8.11"
6+
---
17
# [1.8.0](https://github.com/gregsdennis/json-everything/pull/418) {#release-more-1.8.0}
28

39
- `EnumStringConverter<T>` now supports reading and writing dictionary keys.
@@ -116,4 +122,4 @@ Not released; skipped for some reason.
116122

117123
# 1.0.0 {#release-more-1.0.0}
118124

119-
Initial release.
125+
Initial release.

‎_docs/release-notes/json-patch.md renamed to ‎_docs/release-notes/rn-json-patch.md

+6
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
layout: page
3+
title: JsonPatch.Net
4+
icon: fas fa-tag
5+
order: "8.08"
6+
---
17
# [2.0.6](https://github.com/gregsdennis/json-everything/pull/400) {#release-patch-2.0.6}
28

39
[#397](https://github.com/gregsdennis/json-everything/issues/397) - Fixed an issue where `replace` needs to check that the target location exists before proceeding with the `add` portion of its operation.

‎_docs/release-notes/json-path.md renamed to ‎_docs/release-notes/rn-json-path.md

+7-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
layout: page
3+
title: JsonPath.Net
4+
icon: fas fa-tag
5+
order: "8.07"
6+
---
17
# [0.5.2](https://github.com/gregsdennis/json-everything/pull/431) {#release-path-0.5.2}
28

39
Improved support for regular expressions matching unicode text.
@@ -140,4 +146,4 @@ Better single-quote support.
140146

141147
# 0.1.0 {#release-path-0.1.0}
142148

143-
Initial release.
149+
Initial release.

‎_docs/release-notes/json-pointer.md renamed to ‎_docs/release-notes/rn-json-pointer.md

+6
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
layout: page
3+
title: JsonPointer.Net
4+
icon: fas fa-tag
5+
order: "8.09"
6+
---
17
# [3.0.1](https://github.com/gregsdennis/json-everything/pull/425) {#release-pointer-3.0.1}
28

39
[#408](https://github.com/gregsdennis/json-everything/issues/408) - Fixed an issue where an empty string segment fails for array values. Thanks to [@mbj2011](https://github.com/mbj2011) for finding and reporting this.

‎_docs/release-notes/json-schema-data.md renamed to ‎_docs/release-notes/rn-json-schema-data.md

+7-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
layout: page
3+
title: JsonSchema.Net.Data
4+
icon: fas fa-tag
5+
order: "8.04"
6+
---
17
# 3.1.0 ([#326](https://github.com/gregsdennis/json-everything/pull/326) / [#389](https://github.com/gregsdennis/json-everything/pull/389) / [#392](https://github.com/gregsdennis/json-everything/pull/392)) {#release-schemadata-3.1.0}
28

39
Updated to use JsonSchema.Net v4.
@@ -84,4 +90,4 @@ Added support for nullable reference types.
8490

8591
# [1.0.0](https://github.com/gregsdennis/json-everything/pull/72) {#release-schemadata-1.0.0}
8692

87-
Initial release.
93+
Initial release.

‎_docs/release-notes/json-schema-datageneration.md renamed to ‎_docs/release-notes/rn-json-schema-datageneration.md

+6
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
layout: page
3+
title: JsonSchema.Net.DataGeneration
4+
icon: fas fa-tag
5+
order: "8.03"
6+
---
17
# 1.1.0 (no PR) {#release-schemadatagen-1.1.0}
28

39
Updated JsonSchema.Net reference to v4.0.0.

‎_docs/release-notes/json-schema-generation.md renamed to ‎_docs/release-notes/rn-json-schema-generation.md

+7-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
layout: page
3+
title: JsonSchema.Net.Generation
4+
icon: fas fa-tag
5+
order: "8.02"
6+
---
17
# 3.1.0 (no PR) {#release-schemagen-3.1.0}
28

39
Updated JsonSchema.Net reference to v4.0.0.
@@ -173,4 +179,4 @@ Added debug symbols to package. No functional change.
173179

174180
# [1.0.0](https://github.com/gregsdennis/json-everything/pull/41) {#release-schemagen-1.0.0}
175181

176-
Initial release.
182+
Initial release.

‎_docs/release-notes/json-schema-openapi.md renamed to ‎_docs/release-notes/rn-json-schema-openapi.md

+7-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
layout: page
3+
title: JsonSchema.Net.OpenApi
4+
icon: fas fa-tag
5+
order: "8.06"
6+
---
17
# 1.1.0 ([#326](https://github.com/gregsdennis/json-everything/pull/326) / [#389](https://github.com/gregsdennis/json-everything/pull/389)) {#release-schemaopenapi-1.1.0}
28

39
Updated to use JsonSchema.Net v4.
@@ -6,4 +12,4 @@ Added extensions for each keyword to enable easier keyword value access, e.g. `s
612

713
# 1.0.0 {#release-schemaopenapi-1.0.0}
814

9-
Initial release
15+
Initial release

‎_docs/release-notes/json-schema-unique-keys.md renamed to ‎_docs/release-notes/rn-json-schema-unique-keys.md

+7-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
layout: page
3+
title: JsonSchema.Net.UniqueKeys
4+
icon: fas fa-tag
5+
order: "8.05"
6+
---
17
# 2.1.0 ([#326](https://github.com/gregsdennis/json-everything/pull/326) / [#366](https://github.com/gregsdennis/json-everything/pull/366) / [#389](https://github.com/gregsdennis/json-everything/pull/389)) {#release-schemauniquekeys-2.1.0}
28

39
Updated to use JsonSchema.Net v4.
@@ -30,4 +36,4 @@ Updated JsonPointer.Net to v2.0.0. Please see [release notes](./json-pointer.md
3036

3137
# [1.0.0](https://github.com/gregsdennis/json-everything/pull/120) {#release-schemauniquekeys-1.0.0}
3238

33-
Initial release.
39+
Initial release.

‎_docs/release-notes/json-schema.md renamed to ‎_docs/release-notes/rn-json-schema.md

+6
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
layout: page
3+
title: JsonSchema.Net
4+
icon: fas fa-tag
5+
order: "8.01"
6+
---
17
# [4.1.1](https://github.com/gregsdennis/json-everything/pull/447) {#release-schema-4.1.1}
28

39
[Powershell PR #19610](https://github.com/PowerShell/PowerShell/pull/19610) - Support for \*nix-based file paths caused an error in setting the base URI that resulted in the first folder in the path being interpreted as the URI host.

‎_docs/release-notes/yaml.md renamed to ‎_docs/release-notes/rn-yaml.md

+7-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,13 @@
1+
---
2+
layout: page
3+
title: Yaml2JsonNode
4+
icon: fas fa-tag
5+
order: "8.12"
6+
---
17
# [1.1.0](https://github.com/gregsdennis/json-everything/pull/387) {#release-yaml-1.1.0}
28

39
[#381](https://github.com/gregsdennis/json-everything/issues/381) - Adds conversions from `JsonNode` back to YAML.
410

511
# [1.0.0](https://github.com/gregsdennis/json-everything/pull/358) {#release-yaml-1.0.0}
612

7-
Initial release.
13+
Initial release.

‎_docs/release-notes/title.md

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
bookmark: Release Notes
3+
folder: true
4+
order: "8"
5+
separator: true
6+
---

‎_docs/jsonschema.net/schema-basics.md renamed to ‎_docs/schema/basics.md

+2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
---
22
layout: page
33
title: JsonSchema.Net Basics
4+
md_title: _JsonSchema.Net_ Basics
45
bookmark: Basics
6+
permalink: /schema/:title/
57
icon: fas fa-tag
68
order: "1.1"
79
---

0 commit comments

Comments
 (0)