Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
## Building the site

The registry site uses [jekyll](https://jekyllrb.com/),
a Ruby based static site generator, with the Dinky theme.
a Ruby based static site generator, with [Just the Docs](https://github.com/just-the-docs/just-the-docs).

### Docker dev

Expand All @@ -26,7 +26,7 @@ bundle install
With all the gems (dependencies) installed, you can launch the jekyll server.

``` bash
bundle exec jekyll serve
bundle exec jekyll serve --livereload
```

It will show output like this, and you can grab the Server address
Expand Down
4 changes: 3 additions & 1 deletion Gemfile
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

source "https://rubygems.org"

gem "jekyll", "~> 4.2"
gem "jekyll", "~> 4.4"
gem "webrick", "~> 1.7"
gem "jekyll-remote-theme"
gem "jekyll-include-cache", "~>0.2.1"
Expand All @@ -11,3 +11,5 @@ gem "just-the-docs", "~> 0.4.2"
group :jekyll_plugins do
gem "jekyll-sitemap", "~> 1.4"
end

gem "bigdecimal", "~> 3.2"
39 changes: 24 additions & 15 deletions Gemfile.lock
Original file line number Diff line number Diff line change
Expand Up @@ -3,30 +3,37 @@ GEM
specs:
addressable (2.8.1)
public_suffix (>= 2.0.2, < 6.0)
base64 (0.3.0)
bigdecimal (3.2.3)
colorator (1.1.0)
concurrent-ruby (1.2.2)
concurrent-ruby (1.3.5)
csv (3.3.5)
em-websocket (0.5.3)
eventmachine (>= 0.12.9)
http_parser.rb (~> 0)
eventmachine (1.2.7)
ffi (1.15.5)
ffi (1.17.2)
ffi (1.17.2-x64-mingw-ucrt)
forwardable-extended (2.6.0)
google-protobuf (3.22.2)
google-protobuf (3.22.2-x64-mingw-ucrt)
google-protobuf (3.25.8)
google-protobuf (3.25.8-x64-mingw-ucrt)
http_parser.rb (0.8.0)
i18n (1.12.0)
i18n (1.14.7)
concurrent-ruby (~> 1.0)
jekyll (4.3.2)
jekyll (4.4.1)
addressable (~> 2.4)
base64 (~> 0.2)
colorator (~> 1.0)
csv (~> 3.0)
em-websocket (~> 0.5)
i18n (~> 1.0)
jekyll-sass-converter (>= 2.0, < 4.0)
jekyll-watch (~> 2.0)
json (~> 2.6)
kramdown (~> 2.3, >= 2.3.1)
kramdown-parser-gfm (~> 1.0)
liquid (~> 4.0)
mercenary (>= 0.3.6, < 0.5)
mercenary (~> 0.3, >= 0.3.6)
pathutil (~> 0.9)
rouge (>= 3.0, < 5.0)
safe_yaml (~> 1.0)
Expand All @@ -47,16 +54,17 @@ GEM
jekyll (>= 3.7, < 5.0)
jekyll-watch (2.2.1)
listen (~> 3.0)
json (2.13.2)
just-the-docs (0.4.2)
jekyll (>= 3.8.5)
jekyll-seo-tag (>= 2.0)
rake (>= 12.3.1)
kramdown (2.4.0)
rexml
kramdown (2.5.1)
rexml (>= 3.3.9)
kramdown-parser-gfm (1.1.0)
kramdown (~> 2.0)
liquid (4.0.4)
listen (3.8.0)
listen (3.9.0)
rb-fsevent (~> 0.10, >= 0.10.3)
rb-inotify (~> 0.9, >= 0.9.10)
mercenary (0.4.0)
Expand All @@ -65,10 +73,10 @@ GEM
public_suffix (5.0.1)
rake (13.0.6)
rb-fsevent (0.11.2)
rb-inotify (0.10.1)
rb-inotify (0.11.1)
ffi (~> 1.0)
rexml (3.2.5)
rouge (3.30.0)
rexml (3.4.4)
rouge (4.6.0)
rubyzip (2.3.2)
safe_yaml (1.0.5)
sass-embedded (1.58.3)
Expand All @@ -78,15 +86,16 @@ GEM
google-protobuf (~> 3.21)
terminal-table (3.0.2)
unicode-display_width (>= 1.1.1, < 3)
unicode-display_width (2.4.2)
unicode-display_width (2.6.0)
webrick (1.8.1)

PLATFORMS
ruby
x64-mingw-ucrt

DEPENDENCIES
jekyll (~> 4.2)
bigdecimal (~> 3.2)
jekyll (~> 4.4)
jekyll-include-cache (~> 0.2.1)
jekyll-remote-theme
jekyll-sitemap (~> 1.4)
Expand Down
15 changes: 1 addition & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,17 +15,4 @@ This site contains the OpenAPI Initiative Registry and content for the HTML vers

## Development

> [!NOTE]
> As of 2024-08-28 Jekyll version 4.3.2 does _not_ work with Ruby 3.3.x.
>
> Make sure you have Ruby 3.2.x or lower installed.

Install [jekyll](https://jekyllrb.com/docs/installation/) for your platform, install the site
~~~sh
bundle install
~~~
run it
~~~sh
bundle exec jekyll serve --livereload
~~~
and change it to your heart's content :sunglasses:
Please follow the instructions in the [Contributing Guide](./CONTRIBUTING.md).