Skip to content

Move docs to docs/site; add Gemfile for local Jekyll preview #171

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
bfarmer67 merged 2 commits into from
Apr 13, 2026
Merged

Move docs to docs/site; add Gemfile for local Jekyll preview #171

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c2dfadb
Move docs to docs/site; add Gemfile + local Jekyll preview doc
bfarmer67 Apr 13, 2026
a447465
Strip UTF-8 BOMs and replace non-ASCII chars with ASCII
bfarmer67 Apr 13, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/deploy-gh-pages.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ jobs:
- name: Build with Jekyll
uses: actions/jekyll-build-pages@v1
with:
source: ./docs
source: ./docs/site
destination: ./_site
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
Expand Down
9 changes: 9 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -403,3 +403,12 @@ claude.md
**/claude-tasks.md
**/baseline-benchmarks.md
/nuget.config

# Jekyll / GitHub Pages local build
_site/
.jekyll-cache/
.jekyll-metadata
.sass-cache/
vendor/
.bundle/
docs/site/Gemfile.lock
2 changes: 1 addition & 1 deletion Hyperbee.Json.slnx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<File Path="LICENSE" />
<File Path="README.md" />
<File Path="version.json" />
<Project Path="docs/docs.shproj" />
<Project Path="docs/site/docs.shproj" />
</Folder>
<Folder Name="/Solution Items/.github/">
<File Path=".github/dependabot.yml" />
Expand Down
13 changes: 13 additions & 0 deletions docs/site/Gemfile
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
source "https://rubygems.org"

gem "jekyll", "~> 4.3"
gem "just-the-docs"

group :jekyll_plugins do
gem "jekyll-remote-theme"
gem "jekyll-include-cache"
gem "jekyll-seo-tag"
gem "jekyll-relative-links"
end

gem "webrick", "~> 1.8"
0 docs/_config.yml → docs/site/_config.yml
View file
Open in desktop
File renamed without changes.
2 changes: 1 addition & 1 deletion docs/_includes/nav_footer_custom.html → docs/site/_includes/nav_footer_custom.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
<footer class="site-footer">
<footer class="site-footer">
Hyperbee Json Docs
</footer>#*
0 docs/additional-classes.md → docs/site/additional-classes.md
View file
Open in desktop
File renamed without changes.
0 docs/docs.projitems → docs/site/docs.projitems
View file
Open in desktop
File renamed without changes.
0 docs/docs.shproj → docs/site/docs.shproj
View file
Open in desktop
File renamed without changes.
0 docs/index.md → docs/site/index.md
View file
Open in desktop
File renamed without changes.
0 docs/jsonpatch.md → docs/site/jsonpatch.md
View file
Open in desktop
File renamed without changes.
52 changes: 26 additions & 26 deletions docs/jsonpath/comparison.md → docs/site/jsonpath/comparison.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
---
---
layout: default
title: Comparison
parent: JsonPath
Expand Down Expand Up @@ -101,36 +101,36 @@ Here is a performance comparison of various queries on the standard book store d
| Method | Mean | Error | StdDev | Allocated
| :----------------------- | ---------: | ----------: | ---------: | ---------:
| `$..* First()`
| Hyperbee_JsonElement | 2.874 μs | 1.6256 μs | 0.0891 μs | 3.52 KB
| Hyperbee_JsonNode | 3.173 μs | 0.7979 μs | 0.0437 μs | 3.09 KB
| JsonEverything_JsonNode | 3.199 μs | 2.4697 μs | 0.1354 μs | 3.53 KB
| JsonCons_JsonElement | 5.976 μs | 8.4042 μs | 0.4607 μs | 8.48 KB
| Newtonsoft_JObject | 9.219 μs | 2.9245 μs | 0.1603 μs | 14.22 KB
| Hyperbee_JsonElement | 2.874 us | 1.6256 us | 0.0891 us | 3.52 KB
| Hyperbee_JsonNode | 3.173 us | 0.7979 us | 0.0437 us | 3.09 KB
| JsonEverything_JsonNode | 3.199 us | 2.4697 us | 0.1354 us | 3.53 KB
| JsonCons_JsonElement | 5.976 us | 8.4042 us | 0.4607 us | 8.48 KB
| Newtonsoft_JObject | 9.219 us | 2.9245 us | 0.1603 us | 14.22 KB
| | | | |
| `$..*`
| JsonCons_JsonElement | 5.674 μs | 3.8650 μs | 0.2119 μs | 8.45 KB
| Hyperbee_JsonElement | 7.934 μs | 3.5907 μs | 0.1968 μs | 9.13 KB
| Hyperbee_JsonNode | 10.457 μs | 7.7120 μs | 0.4227 μs | 10.91 KB
| Newtonsoft_JObject | 10.722 μs | 4.1310 μs | 0.2264 μs | 14.86 KB
| JsonEverything_JsonNode | 23.096 μs | 10.8629 μs | 0.5954 μs | 36.81 KB
| JsonCons_JsonElement | 5.674 us | 3.8650 us | 0.2119 us | 8.45 KB
| Hyperbee_JsonElement | 7.934 us | 3.5907 us | 0.1968 us | 9.13 KB
| Hyperbee_JsonNode | 10.457 us | 7.7120 us | 0.4227 us | 10.91 KB
| Newtonsoft_JObject | 10.722 us | 4.1310 us | 0.2264 us | 14.86 KB
| JsonEverything_JsonNode | 23.096 us | 10.8629 us | 0.5954 us | 36.81 KB
| | | | |
| `$..price`
| Hyperbee_JsonElement | 4.428 μs | 4.6731 μs | 0.2561 μs | 4.2 KB
| JsonCons_JsonElement | 5.355 μs | 1.1624 μs | 0.0637 μs | 5.65 KB
| Hyperbee_JsonNode | 7.931 μs | 0.6970 μs | 0.0382 μs | 7.48 KB
| Newtonsoft_JObject | 10.334 μs | 8.2331 μs | 0.4513 μs | 14.4 KB
| JsonEverything_JsonNode | 17.000 μs | 14.9812 μs | 0.8212 μs | 27.63 KB
| Hyperbee_JsonElement | 4.428 us | 4.6731 us | 0.2561 us | 4.2 KB
| JsonCons_JsonElement | 5.355 us | 1.1624 us | 0.0637 us | 5.65 KB
| Hyperbee_JsonNode | 7.931 us | 0.6970 us | 0.0382 us | 7.48 KB
| Newtonsoft_JObject | 10.334 us | 8.2331 us | 0.4513 us | 14.4 KB
| JsonEverything_JsonNode | 17.000 us | 14.9812 us | 0.8212 us | 27.63 KB
| | | | |
| `$.store.book[?(@.price == 8.99)]`
| Hyperbee_JsonElement | 4.153 μs | 3.6089 μs | 0.1978 μs | 5.24 KB
| JsonCons_JsonElement | 4.873 μs | 1.0395 μs | 0.0570 μs | 5.05 KB
| Hyperbee_JsonNode | 6.980 μs | 5.1007 μs | 0.2796 μs | 8 KB
| Newtonsoft_JObject | 10.629 μs | 3.9096 μs | 0.2143 μs | 15.84 KB
| JsonEverything_JsonNode | 11.133 μs | 7.2544 μs | 0.3976 μs | 15.85 KB
| Hyperbee_JsonElement | 4.153 us | 3.6089 us | 0.1978 us | 5.24 KB
| JsonCons_JsonElement | 4.873 us | 1.0395 us | 0.0570 us | 5.05 KB
| Hyperbee_JsonNode | 6.980 us | 5.1007 us | 0.2796 us | 8 KB
| Newtonsoft_JObject | 10.629 us | 3.9096 us | 0.2143 us | 15.84 KB
| JsonEverything_JsonNode | 11.133 us | 7.2544 us | 0.3976 us | 15.85 KB
| | | | |
| `$.store.book[0]`
| Hyperbee_JsonElement | 2.677 μs | 2.2733 μs | 0.1246 μs | 2.27 KB
| Hyperbee_JsonNode | 3.126 μs | 3.5345 μs | 0.1937 μs | 2.77 KB
| JsonCons_JsonElement | 3.229 μs | 0.0681 μs | 0.0037 μs | 3.21 KB
| JsonEverything_JsonNode | 4.612 μs | 2.0037 μs | 0.1098 μs | 5.96 KB
| Newtonsoft_JObject | 9.627 μs | 1.1498 μs | 0.0630 μs | 14.56 KB
| Hyperbee_JsonElement | 2.677 us | 2.2733 us | 0.1246 us | 2.27 KB
| Hyperbee_JsonNode | 3.126 us | 3.5345 us | 0.1937 us | 2.77 KB
| JsonCons_JsonElement | 3.229 us | 0.0681 us | 0.0037 us | 3.21 KB
| JsonEverything_JsonNode | 4.612 us | 2.0037 us | 0.1098 us | 5.96 KB
| Newtonsoft_JObject | 9.627 us | 1.1498 us | 0.0630 us | 14.56 KB
2 changes: 1 addition & 1 deletion docs/jsonpath/functions.md → docs/site/jsonpath/functions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
---
---
layout: default
title: Functions
parent: JsonPath
Expand Down
2 changes: 1 addition & 1 deletion docs/jsonpath/jsonpath.md → docs/site/jsonpath/jsonpath.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
---
---
layout: default
title: JsonPath
has_children: true
Expand Down
2 changes: 1 addition & 1 deletion docs/jsonpath/overview.md → docs/site/jsonpath/overview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
---
---
layout: default
title: Overview
parent: JsonPath
Expand Down
0 docs/jsonpath/syntax.md → docs/site/jsonpath/syntax.md
View file
Open in desktop
File renamed without changes.
0 docs/jsonpointer.md → docs/site/jsonpointer.md
View file
Open in desktop
File renamed without changes.
Loading
Loading