-
-
Notifications
You must be signed in to change notification settings - Fork 752
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[dep] Upgrade theme to 0.5.4 #2243
Conversation
@captn3m0 rc4 is released 6 hours ago : https://github.com/just-the-docs/just-the-docs/releases/tag/v0.4.0.rc4 |
Updated the PR for RC4.0 (pushing in a bit) Main changes:
Profile Measurements for RC4:Build Process Summary:
Site Render Stats:
|
logo changeSwitched to a full-image logo to avoid hack from https://github.com/endoflife-date/endoflife.date/pull/1900/files#diff-763ac3523acb81380882833d64791adae805b37ea3429ea95cb44b8f5c439593 Favicon FixesDropped the ICO file, and redirect to the PNG file instead. |
Dropping the
It's a tax of 7 seconds, but we don't have to maintain our own |
87fde4d
to
f34c39b
Compare
0.4.0 has been released : https://github.com/just-the-docs/just-the-docs/releases/tag/v0.4.0. |
@captn3m0, I rebased the branch against master, upgraded jtd to 0.4.0 and upgrade the dependencies. I quickly checked the result after that and, appart for the 3 Sass warning when the site is build, so far it looks good. |
With most of (all ?) the absolute links replaced by relative one in jtd 0.4.0, the |
Rebased against master and upgraded to jtd 0.4.1. @captn3m0, I think it's good enough for being merged after an extensive review. Do you think some more work is needed ? |
Will review and merge this over the weekend.
|
FYI I already did a quick review and didn't had anything to say. The only thing I thought of was the build time increase, but from what I can see that can't be avoided without modifying the theme itself, so LGTM. |
- See just-the-docs/just-the-docs#956 - This is still 7-8 seconds slower than our fast version, but this lets us stay closer to upstream
Not needed anymore with JTD 0.5.1.
This link work in local environement, but not on netlify preview (blank url).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The build times are still on the higher side, but still manageable.
Going ahead and merging ✔️
Thanks a lot @marcwrobel for keeping at it.
Next minor version should fix the build time issue with just-the-docs/just-the-docs#1244. On my computer:
Test ran with the following modifications: diff --git c/Gemfile i/Gemfile
index 406df285..e6a584c5 100644
--- c/Gemfile
+++ i/Gemfile
@@ -14,6 +14,8 @@ group :jekyll_plugins do
gem 'jekyll-seo-tag'
gem 'jekyll-last-modified-at'
gem 'jemoji'
+ gem "jekyll-remote-theme"
+ gem "jekyll-include-cache"
end
# Windows does not include zoneinfo files, so bundle the tzinfo-data gem
diff --git c/Gemfile.lock i/Gemfile.lock
index 3ae1e94c..3cc841d0 100644
--- c/Gemfile.lock
+++ i/Gemfile.lock
@@ -46,9 +46,16 @@ GEM
webrick (~> 1.7)
jekyll-feed (0.17.0)
jekyll (>= 3.7, < 5.0)
+ jekyll-include-cache (0.2.1)
+ jekyll (>= 3.7, < 5.0)
jekyll-last-modified-at (1.3.0)
jekyll (>= 3.7, < 5.0)
posix-spawn (~> 0.3.9)
+ jekyll-remote-theme (0.4.3)
+ addressable (~> 2.0)
+ jekyll (>= 3.5, < 5.0)
+ jekyll-sass-converter (>= 1.0, <= 3.0.0, != 2.0.0)
+ rubyzip (>= 1.3.0, < 3.0)
jekyll-sass-converter (3.0.0)
sass-embedded (~> 1.54)
jekyll-seo-tag (2.8.0)
@@ -91,6 +98,7 @@ GEM
ffi (~> 1.0)
rexml (3.2.5)
rouge (4.1.2)
+ rubyzip (2.3.2)
safe_yaml (1.0.5)
sass-embedded (1.64.1)
google-protobuf (~> 3.23)
@@ -110,7 +118,9 @@ DEPENDENCIES
icalendar (~> 2.7)
jekyll (~> 4.3.2)
jekyll-feed (~> 0.17)
+ jekyll-include-cache
jekyll-last-modified-at
+ jekyll-remote-theme
jekyll-seo-tag
jekyll-timeago
jemoji
diff --git c/_config.yml i/_config.yml
index 5751f3be..68a28b53 100644
--- c/_config.yml
+++ i/_config.yml
@@ -14,11 +14,13 @@ plugins:
- jekyll-timeago
- jekyll-seo-tag
- jekyll-last-modified-at
+ - jekyll-remote-theme
+ - jekyll-include-cache
- jemoji
# just-the-docs settings, see https://just-the-docs.com/
-theme: just-the-docs
+remote_theme: pdmosses/just-the-docs@nav-fix
nav_sort: case_insensitive
# https://just-the-docs.com/docs/configuration/#search
diff --git c/_includes/css/activation.scss.liquid i/_includes/css/activation.scss.liquid
new file mode 100644
index 00000000..e69de29b |
Upgrade our theme to 0.5.4.
Important Changes:
Might have missed some.
These might land soon, and might be helpful:
Release notes :