diff --git a/README.md b/README.md index 5655f1b..cb9ef9d 100644 --- a/README.md +++ b/README.md @@ -20,29 +20,28 @@ JSONPath is a query language for JSON, allowing you to navigate and extract data Hyperbee.Json's JSONPath implementation is designed for optimal performance, ensuring low memory allocations and fast query execution. It fully conforms to [RFC 9535](https://www.rfc-editor.org/rfc/rfc9535.html). -[Read more about JsonPath](jsonpath/index.md) -[Read more about JsonPath syntax](jsonpath/jsonpath-syntax.md) +[Read more about JsonPath](https://stillpoint-software.github.io/hyperbee.json/jsonpath/jsonpath.html) ## JSONPointer JSONPointer is a syntax for identifying a specific value within a JSON document. It is simple and easy to use, making it an excellent choice for pinpointing exact values. Hyperbee.Json's JsonPointer implementation adheres to [RFC 6901](https://www.rfc-editor.org/rfc/rfc6901.html). -[Documentation for JsonPointer coming soon] +[Read more about JsonPointer](https://stillpoint-software.github.io/hyperbee.json/jsonpointer.html) ## JSONPatch JSONPatch is a format for describing changes to a JSON document. It allows you to apply partial modifications to JSON data efficiently. Hyperbee.Json supports JsonPatch as defined in [RFC 6902](https://www.rfc-editor.org/rfc/rfc6902.html), ensuring compatibility and reliability. -[Read more about JsonPatch](jsonpatch.md) +[Read more about JsonPatch](https://stillpoint-software.github.io/hyperbee.json/jsonpatch.html) ## JSONDiff JSONDiff allows you to compute the difference between two JSON documents, which is useful for versioning and synchronization. Hyperbee.Json's implementation is optimized for performance and low memory usage, adhering to the standards set in [RFC 6902](https://www.rfc-editor.org/rfc/rfc6902.html). -[Read more about JsonDiff](jsonpatch.md) +[Read more about JsonDiff](https://stillpoint-software.github.io/hyperbee.json/jsonpatch.html#jsondiff) ## Getting Started @@ -54,10 +53,6 @@ Install via NuGet: dotnet add package Hyperbee.Json ``` -## Documentation - -Documentation can be found in the project's `/docs` folder. - ## Benchmarks Here is a performance comparison of various queries on the standard book store document. diff --git a/docs/_config.yml b/docs/_config.yml index f5f0ffc..bb3c3df 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -1,6 +1,8 @@ title: Hyperbee Json description: Documentation for Hyperbee Json. remote_theme: pmarsceill/just-the-docs +baseurl: "/hyperbee.json/" +url: "https://stillpoint-software.github.io" aux_links: "GitHub Repository": @@ -8,3 +10,9 @@ aux_links: # logo: "/assets/icon.png" search_enabled: true # Enable search + +# External navigation links +nav_external_links: + - title: Stillpoint Software + url: https://www.stillpointsoftware.net/ + opens_in_new_tab: true diff --git a/docs/docs.projitems b/docs/docs.projitems index 28add02..dec21d8 100644 --- a/docs/docs.projitems +++ b/docs/docs.projitems @@ -12,9 +12,12 @@ + - + + + \ No newline at end of file diff --git a/docs/index.md b/docs/index.md index 991330b..27fe531 100644 --- a/docs/index.md +++ b/docs/index.md @@ -26,29 +26,28 @@ JSONPath is a query language for JSON, allowing you to navigate and extract data Hyperbee.Json's JSONPath implementation is designed for optimal performance, ensuring low memory allocations and fast query execution. It fully conforms to [RFC 9535](https://www.rfc-editor.org/rfc/rfc9535.html). -[Read more about JsonPath](jsonpath/index.md) -[Read more about JsonPath syntax](jsonpath/jsonpath-syntax.md) +[Read more about JsonPath]({{ site.url }}{{ site.baseurl }}jsonpath/jsonpath.html) ## JSONPointer JSONPointer is a syntax for identifying a specific value within a JSON document. It is simple and easy to use, making it an excellent choice for pinpointing exact values. Hyperbee.Json's JsonPointer implementation adheres to [RFC 6901](https://www.rfc-editor.org/rfc/rfc6901.html). -[Documentation for JsonPointer coming soon] +[Read more about JsonPointer]({{ site.url }}{{ site.baseurl }}jsonpointer.html) ## JSONPatch JSONPatch is a format for describing changes to a JSON document. It allows you to apply partial modifications to JSON data efficiently. Hyperbee.Json supports JsonPatch as defined in [RFC 6902](https://www.rfc-editor.org/rfc/rfc6902.html), ensuring compatibility and reliability. -[Read more about JsonPatch](jsonpatch.md) +[Read more about JsonPatch]({{ site.url }}{{ site.baseurl }}jsonpatch.html) ## JSONDiff JSONDiff allows you to compute the difference between two JSON documents, which is useful for versioning and synchronization. Hyperbee.Json's implementation is optimized for performance and low memory usage, adhering to the standards set in [RFC 6902](https://www.rfc-editor.org/rfc/rfc6902.html). -[Read more about JsonDiff](jsonpatch.md) +[Read more about JsonDiff]({{ site.url }}{{ site.baseurl }}jsonpatch.html#jsondiff) ## Getting Started @@ -60,10 +59,6 @@ Install via NuGet: dotnet add package Hyperbee.Json ``` -## Additional Documentation - -Additional documentation can be found in the project's `/docs` folder. - ## Credits Hyperbee.Json is built upon the great work of several open-source projects. Special thanks to: diff --git a/docs/jsonpatch.md b/docs/jsonpatch.md index 17949e8..2929876 100644 --- a/docs/jsonpatch.md +++ b/docs/jsonpatch.md @@ -91,7 +91,9 @@ var patch = new JsonPatch( ); ``` -Or by using JsonDiff to generate a patch from two JSON documents. +### JsonDiff + +JsonPatch `PatchOperation` can also be generated from the difference between two JSON documents. ```csharp var source = JsonNode.Parse(