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 00000000000..d18fc0980e9 Binary files /dev/null and b/website/assets/images/favicon.ico differ