diff --git a/Dockerfile b/Dockerfile index 36a55be08b..27986617ca 100644 --- a/Dockerfile +++ b/Dockerfile @@ -3,7 +3,7 @@ FROM bretfisher/jekyll-serve WORKDIR /site # install dependencies -COPY Gemfile Gemfile.lock . +COPY Gemfile Gemfile.lock ./ RUN bundle install # install the site diff --git a/Gemfile b/Gemfile index 5733772cd9..dc5ce93dba 100644 --- a/Gemfile +++ b/Gemfile @@ -5,7 +5,7 @@ source "https://rubygems.org" gem "jekyll", "~> 4.2" gem "webrick", "~> 1.7" gem "jekyll-remote-theme" -gem "jekyll-theme-dinky" +gem "just-the-docs", "~> 0.4.2" group :jekyll_plugins do gem "jekyll-sitemap", "~> 1.4" diff --git a/Gemfile.lock b/Gemfile.lock index 559392bcb6..92a7e29239 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -11,7 +11,7 @@ GEM eventmachine (1.2.7) ffi (1.15.5) forwardable-extended (2.6.0) - google-protobuf (3.22.2-x86_64-linux) + google-protobuf (3.22.2) http_parser.rb (0.8.0) i18n (1.12.0) concurrent-ruby (~> 1.0) @@ -42,11 +42,12 @@ GEM jekyll (>= 3.8, < 5.0) jekyll-sitemap (1.4.0) jekyll (>= 3.7, < 5.0) - jekyll-theme-dinky (0.2.0) - jekyll (> 3.5, < 5.0) - jekyll-seo-tag (~> 2.0) jekyll-watch (2.2.1) listen (~> 3.0) + 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-parser-gfm (1.1.0) @@ -59,29 +60,31 @@ GEM pathutil (0.16.2) forwardable-extended (~> 2.6) public_suffix (5.0.1) + rake (13.0.6) rb-fsevent (0.11.2) rb-inotify (0.10.1) ffi (~> 1.0) rexml (3.2.5) - rouge (4.1.0) + rouge (3.30.0) rubyzip (2.3.2) safe_yaml (1.0.5) - sass-embedded (1.59.2-x86_64-linux-gnu) + sass-embedded (1.58.3) google-protobuf (~> 3.21) + rake (>= 10.0.0) terminal-table (3.0.2) unicode-display_width (>= 1.1.1, < 3) unicode-display_width (2.4.2) webrick (1.8.1) PLATFORMS - x86_64-linux + ruby DEPENDENCIES jekyll (~> 4.2) jekyll-remote-theme jekyll-sitemap (~> 1.4) - jekyll-theme-dinky + just-the-docs (~> 0.4.2) webrick (~> 1.7) BUNDLED WITH - 2.4.7 + 1.17.2 diff --git a/_config.yml b/_config.yml index 3f265bad6a..a3e3ba7771 100644 --- a/_config.yml +++ b/_config.yml @@ -1,5 +1,7 @@ -theme: jekyll-theme-dinky -title: OpenAPI Initiative Registry - DRAFT CONTENT +# theme: just-the-docs +remote_theme: just-the-docs/just-the-docs +color_scheme: oai +title: OpenAPI Initiative Registry description: Extensible data value repository show_downloads: true collections_dir: /registries @@ -18,7 +20,8 @@ collections: extension: slug: extension name: Specification Extension Registry - output: true + output: false + hidden: true permalink: /registry/:collection/:title draft-feature: slug: draft-feature @@ -35,3 +38,30 @@ collections: name: Extension Namespace Registry output: true permalink: /registry/:collection/:title +exclude: + - Gemfile + - Gemfile.lock + - tmp + - vendor/bundle +#just_the_docs: +# collections: +# draft-feature: +# name: Draft features +# alternative-schema: +# name: Alternative schemas +# namespace: +# name: Extension namespaces +# draft-feature: +# name: Draft features +# format: +# name: Formats +plugins: + - jekyll-remote-theme + - jekyll-sitemap +aux_links: + "Latest Specification": + - "https://spec.openapis.org/oas/latest.html" +footer_content: "\xA9 2023 OpenAPI Initiative. +
This work is licensed under the Apache 2.0 License. This site is\ + \ maintained at https://github.com/OAI/OpenAPI-Specification/." diff --git a/_sass/color_schemes/oai.scss b/_sass/color_schemes/oai.scss new file mode 100644 index 0000000000..425767eedd --- /dev/null +++ b/_sass/color_schemes/oai.scss @@ -0,0 +1,3 @@ +@import "./color_schemes/light"; + +$link-color: #629b34; diff --git a/_sass/custom/custom.scss b/_sass/custom/custom.scss new file mode 100644 index 0000000000..d767e86c99 --- /dev/null +++ b/_sass/custom/custom.scss @@ -0,0 +1,12 @@ +h1,h2,h3,h4,h5,h6 { color: #4E5B31; } + +a[href] { color: #6BA539; } + +/*.nav-list-link { + text-transform: lowercase; +}*/ + +/* OAI greens +6BA539 +4E5B31 +97D700 */ diff --git a/api/alternative-schema.json b/api/alternative-schema.json index 813043a66a..5dd6faffda 100644 --- a/api/alternative-schema.json +++ b/api/alternative-schema.json @@ -1,4 +1,6 @@ --- +title: Alternative Schema API +parent: API --- { {% for page in site.alternative-schema %}"{{ page.slug }}": { @@ -6,6 +8,7 @@ "title": "{{ page.title }}", "issue": "{{ page.issue }}", "description": "{{ page.description }}", + "url": "{{ site.baseurl }}{{ page.url }}", "owner": "{{ page.owner }}" }{% unless forloop.last %},{% endunless %} {% endfor %} diff --git a/api/draft-feature.json b/api/draft-feature.json index 7ee771d60e..d432f9b5bb 100644 --- a/api/draft-feature.json +++ b/api/draft-feature.json @@ -1,4 +1,6 @@ --- +title: Draft Feature API +parent: API --- { {% for page in site.draft-feature %}"{{ page.slug }}": { @@ -6,6 +8,7 @@ "title": "{{ page.title }}", "issue": "{{ page.issue }}", "description": "{{ page.description }}", + "url": "{{ site.baseurl }}{{ page.url }}", "owner": "{{ page.owner }}" }{% unless forloop.last %},{% endunless %} {% endfor %} diff --git a/api/extension.json b/api/extension.json index 45b948fdc2..972b82583c 100644 --- a/api/extension.json +++ b/api/extension.json @@ -1,4 +1,5 @@ --- +parent: API --- { {% for page in site.extension %}"{{ page.slug }}": { @@ -7,6 +8,7 @@ "issue": "{{ page.issue }}", "description": "{{ page.description }}", "owner": "{{ page.owner }}", + "url": "{{ site.baseurl }}{{ page.url }}", "objects": {{ page.objects | jsonify }}, "schema": {{ page.schema | jsonify }} }{% unless forloop.last %},{% endunless %} diff --git a/api/format.json b/api/format.json index 3f57f3ae6f..beebb92501 100644 --- a/api/format.json +++ b/api/format.json @@ -1,4 +1,6 @@ --- +title: Format API +parent: API --- { {% for page in site.format %}"{{ page.slug }}": { @@ -6,6 +8,7 @@ "title": "{{ page.title }}", "issue": "{{ page.issue }}", "description": "{{ page.description }}", + "url": "{{ site.baseurl }}{{ page.url }}", "owner": "{{ page.owner }}", "base_type": "{{ page.base_type" }}" }{% unless forloop.last %},{% endunless %} diff --git a/api/namespace.json b/api/namespace.json index c86d6f590e..423f3a64a6 100644 --- a/api/namespace.json +++ b/api/namespace.json @@ -1,10 +1,13 @@ --- +title: Namespace API +parent: API --- { {% for page in site.namespace %}"{{ page.slug }}": { "slug": "{{ page.slug }}", "issue": "{{ page.issue }}", "description": "{{ page.description }}", + "url": "{{ site.baseurl }}{{ page.url }}", "owner": "{{ page.owner }}" }{% unless forloop.last %},{% endunless %} {% endfor %} diff --git a/api/registries.json b/api/registries.json index aae5e7149c..335dee0425 100644 --- a/api/registries.json +++ b/api/registries.json @@ -1,4 +1,6 @@ --- +title: Registries API +parent: API --- [ {% for collection in site.collections %}"{{ collection.slug }}"{% unless forloop.last %},{% endunless %} diff --git a/assets/css/style.scss b/assets/css/style.scss deleted file mode 100644 index 72c5761ef1..0000000000 --- a/assets/css/style.scss +++ /dev/null @@ -1,26 +0,0 @@ ---- ---- - -@import "{{ site.theme }}"; - -h1,h2,h3 { color: #629b34; } - -a[href] { color: #45512c; } - -footer { display: none; } - -header > ul > li { - background: #629b34; - box-shadow: inset 0px 1px 1px 0 rgba(33,2,38, 1); -} - -header > ul > li:hover { - background: #45512c; -} - -section:first-of-type { - background-image: url("../img/draft.png"); - background-size: 30%; - background-repeat: repeat; -} - diff --git a/favicon.ico b/favicon.ico new file mode 100644 index 0000000000..e90fcebcb3 Binary files /dev/null and b/favicon.ico differ diff --git a/index.md b/index.md index 76139e38f5..321a5904b7 100644 --- a/index.md +++ b/index.md @@ -1,8 +1,9 @@ --- -title: OpenAPI Initiative gh-pages repository +title: Home description: HTML Spec. and extensible registry layout: default --- + # OpenAPI Initiative Registry This site contains the OpenAPI Initiative Registry and content for the HTML versions of the OpenAPI Specification. diff --git a/registries/_format/byte.md b/registries/_format/byte.md index 04e8c49d31..1ddf3408e1 100644 --- a/registries/_format/byte.md +++ b/registries/_format/byte.md @@ -28,4 +28,4 @@ The `{{page.slug}}` format represents any sequence of octets encoded as a base64 ### Remarks {{ page.remarks }} -{% endif %} \ No newline at end of file +{% endif %} diff --git a/registry/alternative-schema.md b/registry/alternative-schema.md index b5f38275ed..386c7b22b7 100644 --- a/registry/alternative-schema.md +++ b/registry/alternative-schema.md @@ -1,6 +1,8 @@ --- +title: Alternative Schema Registry layout: default permalink: /registry/alternative-schema/index.html +parent: Registry --- # Alternative Schema Type Registry diff --git a/registry/draft-feature.md b/registry/draft-feature.md index 858d5fe402..b8d59a9551 100644 --- a/registry/draft-feature.md +++ b/registry/draft-feature.md @@ -1,6 +1,8 @@ --- +title: Draft Feature Registry layout: default permalink: /registry/draft-feature/index.html +parent: Registry --- # Draft Features Registry diff --git a/registry/extension.md b/registry/extension.md index 77b3e526d9..226b8730e7 100644 --- a/registry/extension.md +++ b/registry/extension.md @@ -1,6 +1,8 @@ --- +# title: Extensions Registry layout: default permalink: /registry/extension/index.html +parent: Registry --- # Extensions Registry diff --git a/registry/format.md b/registry/format.md index 7f1a9b5f2f..4441b232da 100644 --- a/registry/format.md +++ b/registry/format.md @@ -1,6 +1,8 @@ --- +title: Format Registry layout: default permalink: /registry/format/index.html +parent: Registry --- # Formats Registry diff --git a/registry/index.md b/registry/index.md index 5e3baef022..73632ab5c4 100644 --- a/registry/index.md +++ b/registry/index.md @@ -1,6 +1,14 @@ --- +title: Registry layout: default permalink: /registry/index.html +has_children: true +children: +- title: Alternative Schema Registry +- title: Draft Features Registry +- title: Format Registry +- title: Namespace Registry +has_toc: false --- ## Contributing @@ -9,14 +17,13 @@ Please raise a [Pull-Request](https://github.com/OAI/OpenAPI-Specification/pulls ### Contents -{% for registry in site.collections %}{% unless registry.hidden %}* {{ registry.name }}{% endunless %} -{% endfor %} +{% for registry in site.collections %}{% unless registry.hidden %} +* {{ registry.name }}{% endunless %}{% endfor %} #### API access -* [registries.json](../api/registries.json) - Registries meta-registry -{% for registry in site.collections %}{% unless registry.hidden %}* {{ registry.slug }}.json{% endunless %} -{% endfor %} +* [registries.json](../api/registries.json) - Registries meta-registry{% for registry in site.collections %}{% unless registry.hidden %} +* {{ registry.slug }}.json{% endunless %} {% endfor %} #### RSS feed diff --git a/registry/namespace.md b/registry/namespace.md index 24cb4430c6..6b05c8c1b7 100644 --- a/registry/namespace.md +++ b/registry/namespace.md @@ -1,6 +1,8 @@ --- +title: Namespace Registry layout: default permalink: /registry/namespace/index.html +parent: Registry --- # Namespace Registry