From 4a90c90631aa8092ea08059c16fc224692848160 Mon Sep 17 00:00:00 2001 From: Mike Ralphson Date: Fri, 17 Mar 2023 11:38:21 +0000 Subject: [PATCH] [gh-pages] reskin registry site and prep for release Signed-off-by: Mike Ralphson --- Dockerfile | 2 +- Gemfile | 2 +- Gemfile.lock | 21 ++++++++++--------- _config.yml | 36 ++++++++++++++++++++++++++++++--- _sass/color_schemes/oai.scss | 3 +++ _sass/custom/custom.scss | 12 +++++++++++ api/alternative-schema.json | 3 +++ api/draft-feature.json | 3 +++ api/extension.json | 2 ++ api/format.json | 3 +++ api/namespace.json | 3 +++ api/registries.json | 2 ++ assets/css/style.scss | 26 ------------------------ favicon.ico | Bin 0 -> 3723 bytes index.md | 3 ++- registries/_format/byte.md | 2 +- registry/alternative-schema.md | 2 ++ registry/draft-feature.md | 2 ++ registry/extension.md | 2 ++ registry/format.md | 2 ++ registry/index.md | 17 +++++++++++----- registry/namespace.md | 2 ++ 22 files changed, 103 insertions(+), 47 deletions(-) create mode 100644 _sass/color_schemes/oai.scss create mode 100644 _sass/custom/custom.scss delete mode 100644 assets/css/style.scss create mode 100644 favicon.ico 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 0000000000000000000000000000000000000000..e90fcebcb378e980fcd7a06c133c597334b27436 GIT binary patch literal 3723 zcmV;64s`K}P)Gnk-?PaWce3 zkeN+3=PzI`bHR*ETy&brusEhb$JWXZtB8glCsYch+;jJQe8+H!xqRh%&+~km!`wG{ z{Y$vdyU+7|zW2k*ul&ld{L)_ylNv1yz=fEE8*nqO!(|wb0xQ4tLtq$g#|FHQ6Nn>$ zQ#gt?tipJdSox(ABY-Gg#VJSz4h~@{&b9K(*BAx32LFcx$wDul#b^Yq{PG+lh?&?A zaVd$dh``D(Z+k{9c0)XJ@DEg2`QC8@qvx|^G{&zH}U(BfcWS=eBH{gtb>%} z-w>ZAu{giMXCLHBd;(GM5=yQ7$|}eLBq0iRqsq#~b=TTP3k4X63Va2%n275!1tr(q z5~;>FQG?Mq4+9WX3i4Bkl7om?E|yk+5UMc^i}4IzM+ZK{5gf-!Y(+VP{}H+o!+!i1 zFXOlPKI(Bkir`0(hagH~xWdY?G$RC1hA0+c1Kvds9LO2$I31(~0+S?;p&jcmA7fDp zw?TgPrMp5HWDzdGz1W1qNJ0$U1u;wDAU0wls!)(+kok&x$S#bsSp5|uge$Qc9~dI& z1TnMGfd_FZ3i}vjJh~tXHsYNA2vLa3@DyTjAb@g^%#zrL<@g$c8G;POn@Z=9A45Gx z0h;mQ=R@RBkd!2LqXm@+oZ%hb6$(K*)lTZa-coO2Feb0qJR!{BzKdQ+4hKnz<89o4 zBEvhp)A1g}M>c+r0*x2}jKz8!#T|G5v2h5)d+{s@l8W*uLWUTf5Fa^s1r=H`u0jVK z2)3h=;Z4TTvml6#H7HMeyM3ZkjCMredyGQNz-|aq;%I69b3>Q`u7i`qLE`uWD$-)q zV5`C={yORr)VMNk!U2fEUR=rm$Kit<4HCx_C^y7-6HXrnY-jPA`bv!S{mS446wdli zw3vZULnp+*!4toH^;-iO;u6?77Q|}|8_!_@)}s^Mh{HxNKE`&eL>-DPmftaoaTgw# z{k__A8T#}yMCrn{4Dozy$)O;A#8`{run+u+y2Q3&ECMi5tH=h+k^ zfLVw^fUKf)VhqEq#Xj92nPa#-XPm^-xe&v`ShPbR8KO+YRyb)J{FBRG`)q^%32cQR znlXCt0LrY4OFu{$&%=Rai1OgfdC?HVk6pUF#Y%E7<+8^m4 z7&dGDTh&~2L;9c#_sm)t4Kw_!4Y#lLD>v7dG1Mj;g?5lQp2i55hdvu?F)S^{#dr>v zLoa|K$OYH|$-;><>?u8Hy5~;~AqKlj;R7m_M_WUTO-N!r%K9rt5q^avB!g@=`W>iZ zuot0SA&6Ft04~8MI1uz;9s>Olq%Q3d*RLoEta#*KhPUXw1ksPtfVT{L={AhejuFDM za3Bg%j-%=HTl5=!3}Qa?d5_VET@V8sixJceQjd=zfJ&4$T)==EaoBZ`%#XHHu}vvP z%1(^b+&g{`0o0--uzbniCYCbf6)b%6xb{fC&tFH2w#Hjd!pbO^BibVU!?n`j$Epb(oL){5bTvjFHlcp&F<1dy#}F zMR{mOQ}i4{)ZlHrz-RD-81$WJ!`-MtL7)H6NZT`}_A$mOEHxbZCSaF~$NlMk2N{T$ zA&R=OXvXc4Ffpd04c8H1FfKyC(21q}N z;U)yXAVMLkF&B^FCA4BQ{)%O|79$Wg;| zu6AIT!a2jOy%^=k?P@l9Aj)hk$3R1j5;S2i97tc~NDRRVOz|3|08hbzD0>T)rWj~e z_?G!8tWk+!=AhYYkTSGFl*Mr;0*2dElR}IhEX5GD7-ml*=q1P~bV8JMV5H&dxEOmN zF1SAQDS8d1UV=mrgD86jg@&*C{{l&cAHobZJW2iqqO1+WyabsH?G4?=ZHB9(3hzJ^ zf|RDc&LAFzDBFh%y#$#98=~kiY79YcMqDAtAw&(Y^%iKq))*pQf-HmsQPhqK!wLK` zh=K&>8D8rZIE0gmVyN>HWD!K!8wjTb3E}S$CCf}-YeEC2DVl=8UV_|)9m;-(lC&U$ z&1*5YPW&p3i1uveX^4>BO!paemB1kxMVAarmaX_y*&ZoHRVPDn;M1ZuDk z<_2B^u?%NW0Bb$-jN3Sc*{VK6-I4D{4TKw9#S?l2(gsH%Twp~uR-=c~3h)kY!DeSR zyB3c%@Zg&nqY#N5IDiCfMmUDT6Q+8?@WKJyhj0TMK1Lh8YL~2m6~YM>IEJAcPEKqi zTg9mc{xdCjYf1e0*4myLmz_T}uFrWyB~3E(9f_!daDy_0!K6nZ9tcE%6BE8Gh+tQg z(oYORjH*?rm0`lkP|?neF|ntD%<@6Jbc~ETT-#FKH8>O- zcEUr?Kom<+t>N-?9OE{AG0{sFK~B|hX(&MC!tKHB>%xGLZ1`|hTtGWMcQ87kmByCs zjafK}e9R47;NMd|{gH(!OA{t^FgTQd5o|<-xc<1_z~w0m3%ERW;spEWU1#tqy=KFVNi;2$R@ za?=>Iyi;j4IFw4vgUP50qr;G=p4?H<=W$s_@f%b@=oCf`R>q}=D1oHwxNfFYS{Q^3 z2m?b&S1l$QQcH0g&SC1d)Y_sk0Z2k2gkE7te?qw=O+&ekOE$;iGD6Hs2q-ovlu9gw zvBd*q4c@MDa<|2aqR2&ve0AeEFS!v&hGEyf^#{g!@_mOPbX1OTr63O9kpLU&LV0QV z!HH%WN+pDoQqjfaj)O1ii!Ys6cCcX6;`c(7A7ZY9$5bn1XZ|E|A#|1jUpb`CSM4qL zXY$yYb3NqbT|^7QVRBa>zPJLRiF(qf9@^S>DQv!fcYd@egKi^Rv1eVvSf!=zKn(pP0AEY&U(&yMmYxV{xo%ulsgWW^)>}8`m$z>X$qIL9TMWTaApy7ci0+0inlS5mz zQcPCnH^_r4?{iM1X4 zR@5{ylx$FYrJ1}`Sa$N0k?Ud@)mXmgyO18rx)X#O6=4b;ysvy`h|my91ulWBL^FFU zr)()NBHWoUq|5M?E3_5}H#@sKJ)}G55P=E}p)ALUX45k4wUmg>K^}5%doe^KSg~UJ z=^&+;{~?Gba1RSu%ml?PV zp<+WeMw=d#LlzvEforg79qP`FdbX{+e_sR9M5^)j;*I|=(c4t5I1QuFy!s4{EyW)x zsMa{t^~U!QP3$iyYg|K-1px~ZL8sq5UQz2zC<<@HqEN$7cMYl_nwSkoKe!OwfpeRV zEW8f0sU;lpWiOL(0+wbp)NM#PUY;@Eza8h-7apdTbkr59$0GcQY6#?DK;2NcnS^1% zX#~L3q7T`(_+Tx5!OocEKrjCAWQZnKiHnFp=N2D^opKgF@Rmc}Kbo+=D8g5G1>Nvq zji3y;E$oSKoX6j=x@mZukCT`TuZOBdXncma14bYkC-6JUVbf^=u>{#j!XgZV=c6DT zhofi*UxZ>65^)|^k%vN*!GcQ3f>Qj0oA?{{ 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