From 601b4acaedf12bd7749cb453d6f9909209e32d78 Mon Sep 17 00:00:00 2001 From: Pieter Dirk Soels Date: Mon, 10 Oct 2022 21:08:44 +0200 Subject: [PATCH] Improve website styling Co-authored-by: japborst Co-authored-by: Gijs de Jong --- website/Gemfile | 8 +++----- website/_config.yml | 23 ++++++++++++++++++----- website/_includes/head_custom.html | 17 ++++++++--------- website/_sass/custom/custom.scss | 24 ++++++++++++++++++++++++ website/assets/images/favicon.ico | Bin 0 -> 15086 bytes 5 files changed, 53 insertions(+), 19 deletions(-) create mode 100644 website/_sass/custom/custom.scss create mode 100644 website/assets/images/favicon.ico diff --git a/website/Gemfile b/website/Gemfile index 734e7a144a8..75e35e6c0de 100644 --- a/website/Gemfile +++ b/website/Gemfile @@ -1,8 +1,6 @@ ruby File.read(".ruby-version").strip source "https://rubygems.org" -gem "html-proofer", "4.4.1" -gem "jekyll", "4.2.2" -gem "jekyll-sitemap", "1.4" -gem "just-the-docs", "0.4.0.rc2" -gem "webrick", "1.7" +gem "github-pages", "~> 227" +gem "rake", "~> 13.0" # Required for "just-the-docs" theme +gem "webrick", "~> 1.7" diff --git a/website/_config.yml b/website/_config.yml index c1f90f5a020..4302555b7e0 100644 --- a/website/_config.yml +++ b/website/_config.yml @@ -6,9 +6,9 @@ description: >- Error Prone extensions: extra bug checkers and a large battery of Refaster rules. -theme: just-the-docs +remote_theme: just-the-docs/just-the-docs plugins: - - jekyll-sitemap + - jekyll-remote-theme # Files and directories not to be deployed through GitHub pages. exclude: @@ -20,6 +20,18 @@ exclude: # See https://jekyllrb.com/docs/permalinks/#built-in-formats. permalink: pretty +# Theme configuration. +search_enabled: true +heading_anchors: true + +callouts: + summary: + title: Summary + color: blue + warning: + title: Warning + color: red + # Theme (just-the-docs) configuration. # See # https://just-the-docs.github.io/just-the-docs/docs/navigation-structure/#external-navigation-links. @@ -28,6 +40,10 @@ nav_external_links: url: https://github.com/PicnicSupermarket/error-prone-support hide_icon: false +twitter: + username: picnic + card: summary + # SEO configuration. # See https://jekyll.github.io/jekyll-seo-tag/usage. social: @@ -36,6 +52,3 @@ social: - https://github.com/PicnicSupermarket - https://twitter.com/picnic - https://www.linkedin.com/company/picnictechnologies -twitter: - username: picnic - card: summary diff --git a/website/_includes/head_custom.html b/website/_includes/head_custom.html index 74b77b77724..04730f292ca 100644 --- a/website/_includes/head_custom.html +++ b/website/_includes/head_custom.html @@ -1,18 +1,17 @@ - + - + - - - + + + diff --git a/website/_sass/custom/custom.scss b/website/_sass/custom/custom.scss new file mode 100644 index 00000000000..7d562883e0a --- /dev/null +++ b/website/_sass/custom/custom.scss @@ -0,0 +1,24 @@ +// We should override $nav-width(-md), however this breaks code highlighting and other styles. +// This appears an issue wrt the recommended way: +// https://github.com/just-the-docs/just-the-docs/issues/982 +@include mq(lg) { + .side-bar { + min-width: 400px; + } + + .site-nav, .site-header { + width: 400px; + } +} + +// Add support for external anchor icons. +.external > svg { + width: 1rem; + vertical-align: text-bottom; +} + +footer > img#logo { + width: 2rem; + margin: 0 auto; + display: block; +} diff --git a/website/assets/images/favicon.ico b/website/assets/images/favicon.ico new file mode 100644 index 0000000000000000000000000000000000000000..d18fc0980e9ef05b45eb43609398c498cb8463e1 GIT binary patch literal 15086 zcmeHOc~q6v7Qe0c)_VWFSG|8)wN{Zs&VnNjIb^1!*2}EtdS#`iq&Or_C8*h}Cz?YJ zI6{hO4mhAe4j_;qA}SyvlL|P1C}NrqMJ9i5{|+Afxc7qh;#Fa-_pP-#_Z!b|@3YT7 zd+)O`nVvEI$>ic;~Io&^h)?~_-YtKr{`(yrWGR>6-n#(itifOnI zudAa;Wn=!gLx&E}3V8`-2~`N8p3*(Rl`S+==sEHs?capf2$c!dSKQ{f$_1;x&~rjx z3zZ6)KU3e&iJ9Y&*#NO?*;3ydlHO?Cx^?JWZPTU=+O}=0zulnPmMvSNS@Y&-+O#R0 zot+yL_I57q(4XP#Z0;pB1~0$-vckzRA#pr7H(q<~ zHT3A!69JnyBOxsn`=TN-@ZEQ6@Z$Ge3ijJK+DZT3d_S={~dlqKR^TCAa)6la|A2e#*$l>;jG9h*^FE8A@c@xIt z#*G{B_V&ioWy?@rQEt42d-v|)c5yMz3m@b`j|b<<*a;I5mz0PU8KcM($M8$^Z}>U% z7YzOM6E&ue90$sG(4axMcI{d=Z-$LXv@mW)mUgA5>ij&givaBmf|TP zBMl)jhp_ul6ax1Iqic`Xm2GvD9#O{^ELdQH%bp8G!e5%;)jV)4_*+wWd>n$KBCtnz z80j%qjkhE52L=Y(1J~l&ii!%H6Z@+18e8&09U^|}k*C)Tr9+Oyzj5P63rzN2xR8Ij zM*LAm{N7&m692_3`8MLOpYnfF__?;ye(5!q^VbpjQy2W^SROVfT*M!s4@{qhHlIX) z=E>ssQhnl@d(5u-*a zOj@5G#skNRIzL?Ai#~P?pN<%Tfc5Jw@Ys97cKp+&@6V<0cziZ;q{3p0?il&fJPZ)O zp||)|8#ZjP7p}$gRrs?Wth-#tIL1c%KWWC-;-|iew+9Za6L!r9Z4l?pi!Z)d>-?3a z6=fyBJ!$p9_4bPRq9p$2LHwuAoI`R3eNp<>m3)}vpDgRwOE0~o`gVjLM<2bW`CD)q zI1&a#1Osv5!1b%bhxnb5k&)Q7YnP&^s3^Hsfy|7X*dJVkU$@@H0cnq&$W=U;8s+8H;}gw8XlMwsWDfGUeEBkV z?%Y}JS@N?jCdm0Omm$^IAI?f6=~9nKA{dB?dN+G5JoW#4fYH z`wk=BM`PaNMJoQH>`Bpy301m3(`T;I9Y@$5jh`)bXr!zq#S+ifbkOctJ4#ARapvL$ zC2z*?I&LKPlLp-h3fm92cLu3Ek+E+_{AT`vaqzx<`>a8%_1cx|g*E#9F((t1?Dt6A z_013S(ZohStu8##4;&zQzues1TJaihGVV>6+=($>)N5`+dKyCS$L&Au2tt?FyDJ&h z1)DAJ(0`&W9Y20N{`lh$BTTEmsW;~?S;o9tZw|!8syVx5Zz$fCd|hMtwyi#zEqJXx zqy3`k)2D;EpPG)6veK%YiBa|%JM#^+In4Qd`0+=NqL9ujsClv`0ssXU!z-( z9%v&v$2E{+R$p*ilJ6Sb1x+}C?ddeYGMPcy8^v4LDWCpf1Il{65% zMxT`R1FSjutI$fJhExMVooCI7RNYk7pl}>m3sEj)HiPMNnj2?WsvWAo{QXBr{yHnTd1l|OO1?NFdQ;o&kHRSx*_zWbn2$`wOHuy zLJNeR#vEmz#84>or1&=P=XZPi=34u-YH8X_-!4Mk#J9ADf&LDC=*Q#_DF4WP>{u{I zK|h53X+Mwsl2|X|+Qro>K6_weyZWvf?Ji^b^+Q7)_2{iJFo-v97Jh0pwb zd(Rm=kWczu?4v`+j+piDZ!v1j7%X428X@6fiin4M0lsV2VD#8AaB^}|`wD!wu4BQz zUB#bXvSbNjVq&mu+cvx>H3{Qne?C*rIrNIKs<*fK42_1Wu~{% z8+&9=yuEt$vN@knTvDR?WIUyFIE)9m_s{%6$IhMY8VB~@Pikli3k!{`*7&39Hwothksl8cb0GR z+uB~3%YxUbbJX8XGG2ZA_O)65we=q;{JVDTiq0~Z_-*!K4TI`m=DCm9w$Ov&aF;n= zP*70gm>X}@)_;J+^#79D8P;&km0FRS`lmcN?u=2tpFa;1Crv`ZRoOJL;i%TX>^m68 zpE-pQ5}SW7d1ii_eVEJMc+UH@b#88M7V>8qk!%;po=qhv=9x$pvWJtMn}?I>S+WmR zS$m`PpZdo*o3`*_eQO-l6OO;JF6ge50UbREglz}Tra;*S=G94;Bo~)>^bSIPEHq1Gbs3#{AZ>qkd!mi^~ zW;RZwry@jhul_+>#r|}%%l=RoDXaMSc-_5fj~+dW#Dqko%HD5ubad6dNZCgV2|IwG zJ$tYvc&DmOi%UsXH8%@Ztwd|?Z_78ed~Io|1Iwg#%y=-r>+9=_rBdsbm6cU>D>)?v zUf;~dtZ%seYd`UKnyo--BR;S=dRi6J>$_6#@C5=je~kf zT?h`AO;jrf^PwuID1GW&ZtVSa*X#T5(8d9|Ab zYfKym<_D>lZ}sn|d@avu)8HZc{m+j-MvvaTm2I!hzUyy2N=qCZlh%TT`blD+yvBQV z`1aF|zvc_(rxkxP?&kmM5W{t$y2!6C?=bFU-2MChYJcs(U<(D%%~QPnq} zXKcki8n4;2;VFAA9uilLm$}TkB;F@kd!KlR4jqakM~)ygG!#eT;!sq42e}1Tu|xLJ zSNQv3ssCEMCBCM$Z_s{l4K+VXrItbOMaLv3!DGr~i*<{9ajtVO-u&Pm(^;wir#+6A z`fctb(PkQD(NW^pPlgZ2<}F*yUsron58h9Jx2zwm4`a-$<-l*zht}_xmx(`k7r0w| z7e%rjWM=1y?~^6{SHABi&l>yZcZh%a^5v@kyqpT8C6*yCFCP~#<|6jD-$kCe>V1#N zo@h(I#Y|^t=cZ1bs@CL!fOSf(o*fkdFz%coKMn;DE#x3$LYhj}JA3tr|3OA`u z