Skip to content

Commit ee33a0f

Browse files
authored
[gh-pages] reskin registry site and prep for release (#3212)
Signed-off-by: Mike Ralphson <[email protected]>
1 parent 2a862a7 commit ee33a0f

22 files changed

+103
-47
lines changed

Dockerfile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ FROM bretfisher/jekyll-serve
33
WORKDIR /site
44

55
# install dependencies
6-
COPY Gemfile Gemfile.lock .
6+
COPY Gemfile Gemfile.lock ./
77
RUN bundle install
88

99
# install the site

Gemfile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ source "https://rubygems.org"
55
gem "jekyll", "~> 4.2"
66
gem "webrick", "~> 1.7"
77
gem "jekyll-remote-theme"
8-
gem "jekyll-theme-dinky"
8+
gem "just-the-docs", "~> 0.4.2"
99

1010
group :jekyll_plugins do
1111
gem "jekyll-sitemap", "~> 1.4"

Gemfile.lock

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ GEM
1111
eventmachine (1.2.7)
1212
ffi (1.15.5)
1313
forwardable-extended (2.6.0)
14-
google-protobuf (3.22.2-x86_64-linux)
14+
google-protobuf (3.22.2)
1515
http_parser.rb (0.8.0)
1616
i18n (1.12.0)
1717
concurrent-ruby (~> 1.0)
@@ -42,11 +42,12 @@ GEM
4242
jekyll (>= 3.8, < 5.0)
4343
jekyll-sitemap (1.4.0)
4444
jekyll (>= 3.7, < 5.0)
45-
jekyll-theme-dinky (0.2.0)
46-
jekyll (> 3.5, < 5.0)
47-
jekyll-seo-tag (~> 2.0)
4845
jekyll-watch (2.2.1)
4946
listen (~> 3.0)
47+
just-the-docs (0.4.2)
48+
jekyll (>= 3.8.5)
49+
jekyll-seo-tag (>= 2.0)
50+
rake (>= 12.3.1)
5051
kramdown (2.4.0)
5152
rexml
5253
kramdown-parser-gfm (1.1.0)
@@ -59,29 +60,31 @@ GEM
5960
pathutil (0.16.2)
6061
forwardable-extended (~> 2.6)
6162
public_suffix (5.0.1)
63+
rake (13.0.6)
6264
rb-fsevent (0.11.2)
6365
rb-inotify (0.10.1)
6466
ffi (~> 1.0)
6567
rexml (3.2.5)
66-
rouge (4.1.0)
68+
rouge (3.30.0)
6769
rubyzip (2.3.2)
6870
safe_yaml (1.0.5)
69-
sass-embedded (1.59.2-x86_64-linux-gnu)
71+
sass-embedded (1.58.3)
7072
google-protobuf (~> 3.21)
73+
rake (>= 10.0.0)
7174
terminal-table (3.0.2)
7275
unicode-display_width (>= 1.1.1, < 3)
7376
unicode-display_width (2.4.2)
7477
webrick (1.8.1)
7578

7679
PLATFORMS
77-
x86_64-linux
80+
ruby
7881

7982
DEPENDENCIES
8083
jekyll (~> 4.2)
8184
jekyll-remote-theme
8285
jekyll-sitemap (~> 1.4)
83-
jekyll-theme-dinky
86+
just-the-docs (~> 0.4.2)
8487
webrick (~> 1.7)
8588

8689
BUNDLED WITH
87-
2.4.7
90+
1.17.2

_config.yml

Lines changed: 33 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
1-
theme: jekyll-theme-dinky
2-
title: OpenAPI Initiative Registry - DRAFT CONTENT
1+
# theme: just-the-docs
2+
remote_theme: just-the-docs/just-the-docs
3+
color_scheme: oai
4+
title: OpenAPI Initiative Registry
35
description: Extensible data value repository
46
show_downloads: true
57
collections_dir: /registries
@@ -18,7 +20,8 @@ collections:
1820
extension:
1921
slug: extension
2022
name: Specification Extension Registry
21-
output: true
23+
output: false
24+
hidden: true
2225
permalink: /registry/:collection/:title
2326
draft-feature:
2427
slug: draft-feature
@@ -35,3 +38,30 @@ collections:
3538
name: Extension Namespace Registry
3639
output: true
3740
permalink: /registry/:collection/:title
41+
exclude:
42+
- Gemfile
43+
- Gemfile.lock
44+
- tmp
45+
- vendor/bundle
46+
#just_the_docs:
47+
# collections:
48+
# draft-feature:
49+
# name: Draft features
50+
# alternative-schema:
51+
# name: Alternative schemas
52+
# namespace:
53+
# name: Extension namespaces
54+
# draft-feature:
55+
# name: Draft features
56+
# format:
57+
# name: Formats
58+
plugins:
59+
- jekyll-remote-theme
60+
- jekyll-sitemap
61+
aux_links:
62+
"Latest Specification":
63+
- "https://spec.openapis.org/oas/latest.html"
64+
footer_content: "\xA9 2023 OpenAPI Initiative.
65+
<br />This work is licensed under the <a rel=\"license\" href=\"https://www.apache.org/licenses/LICENSE-2.0\"\
66+
>Apache 2.0 License</a>. This site is\
67+
\ maintained at <a href=\"https://github.com/OAI/OpenAPI-Specification/tree/gh-pages/\">https://github.com/OAI/OpenAPI-Specification/</a>."

_sass/color_schemes/oai.scss

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
@import "./color_schemes/light";
2+
3+
$link-color: #629b34;

_sass/custom/custom.scss

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
h1,h2,h3,h4,h5,h6 { color: #4E5B31; }
2+
3+
a[href] { color: #6BA539; }
4+
5+
/*.nav-list-link {
6+
text-transform: lowercase;
7+
}*/
8+
9+
/* OAI greens
10+
6BA539
11+
4E5B31
12+
97D700 */

api/alternative-schema.json

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,14 @@
11
---
2+
title: Alternative Schema API
3+
parent: API
24
---
35
{
46
{% for page in site.alternative-schema %}"{{ page.slug }}": {
57
"slug": "{{ page.slug }}",
68
"title": "{{ page.title }}",
79
"issue": "{{ page.issue }}",
810
"description": "{{ page.description }}",
11+
"url": "{{ site.baseurl }}{{ page.url }}",
912
"owner": "{{ page.owner }}"
1013
}{% unless forloop.last %},{% endunless %}
1114
{% endfor %}

api/draft-feature.json

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,14 @@
11
---
2+
title: Draft Feature API
3+
parent: API
24
---
35
{
46
{% for page in site.draft-feature %}"{{ page.slug }}": {
57
"slug": "{{ page.slug }}",
68
"title": "{{ page.title }}",
79
"issue": "{{ page.issue }}",
810
"description": "{{ page.description }}",
11+
"url": "{{ site.baseurl }}{{ page.url }}",
912
"owner": "{{ page.owner }}"
1013
}{% unless forloop.last %},{% endunless %}
1114
{% endfor %}

api/extension.json

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
---
2+
parent: API
23
---
34
{
45
{% for page in site.extension %}"{{ page.slug }}": {
@@ -7,6 +8,7 @@
78
"issue": "{{ page.issue }}",
89
"description": "{{ page.description }}",
910
"owner": "{{ page.owner }}",
11+
"url": "{{ site.baseurl }}{{ page.url }}",
1012
"objects": {{ page.objects | jsonify }},
1113
"schema": {{ page.schema | jsonify }}
1214
}{% unless forloop.last %},{% endunless %}

api/format.json

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,14 @@
11
---
2+
title: Format API
3+
parent: API
24
---
35
{
46
{% for page in site.format %}"{{ page.slug }}": {
57
"slug": "{{ page.slug }}",
68
"title": "{{ page.title }}",
79
"issue": "{{ page.issue }}",
810
"description": "{{ page.description }}",
11+
"url": "{{ site.baseurl }}{{ page.url }}",
912
"owner": "{{ page.owner }}",
1013
"base_type": "{{ page.base_type" }}"
1114
}{% unless forloop.last %},{% endunless %}

0 commit comments

Comments
 (0)