Gem overrides stylesheet after regenerating site #657

ashmaroli · 2019-10-11T07:04:07Z

Summary

When github-pages is listed under the group :jekyll_plugins in the Gemfile, then on regeneration, a site has its assets/css/style.css overridden by one bundled with one of the themes in the gem.

This issue came to my notice while investigating jekyll/jekyll#7854.

This issue affects

The site generated by GitHub Pages maybe.. maybe not..
Building sites locally

Steps to reproduce

Set up a Jekyll site with at least the following:

Gemfile

source 'https://rubygems.org'
gem 'github-pages', group: :jekyll_plugins

assets/css/style.css with the following:
```
h1 { color: red }
```

An index.html that uses the above stylesheet. (either via a layout or directly)

<!DOCTYPE html>
<html>
  <head>
    <meta charset="UTF-8"/>
    <title>Test Site</title>
    <link rel="stylesheet" href="/assets/css/style.css" />
  </head>
  <body>
    <h1>Hello World</h1>
  </body>
</html>

Serve the site locally and preview at http://localhost:4000/
```
bundle exec jekyll serve
```
Trigger a regeneration by just adding content to the landing page.
```
  <h1>Hello World</h1>
+ <p>Lorem ipsum dolor sit amet</p>
```

What did you expect to happen?

Expected the landing page to be rendered with the new content.

What happened instead?

The following would illustrate better:

Before regeneration:

After regeneration:

The text was updated successfully, but these errors were encountered:

ashmaroli · 2019-10-11T07:22:21Z

Workarounds

Disclaimer: Both of the following are undocumented and may have side-effects

place the gem outside the jekyll_plugins group in the Gemfile.
```
- gem 'github-pages', group: :jekyll_plugins
+ gem 'github-pages'
```
This would warrant adding all necessary plugins in the config file.
Disabling theme in the config file.
Setting theme: null in the config file will also prevent the gem from falling back to the primer stylesheet.

leviem1 · 2020-04-21T12:56:49Z

Hey, fresh installed the gem on MacOS 10.15.4 today. Jekyll was working great until I setup this gem. Exact same behavior happening here, so can confirm this is a thing. Generated assets folder does not contain any of the custom styles, only those from the fallback template. The issue seems to be intermittent, happening only about 25-50% of the time, but very noticeable when making many small changes. Extra detail, I'm using JetBrains IDEs, which I think write to disk on inactivity.

adoyle-h · 2023-02-09T12:15:37Z

I have the same issue. Who can help me?

The _site/index.html built with jekyll build and jekyll serve has not <!DOCTYPE html>, <html>, <head> these tags. Only <h1> <p>.

The _site/index.html built with github-pages works well. It has complete html content.

_config.yml

plugins:
  - jekyll-remote-theme

remote_theme: just-the-docs/just-the-docs

Gemfile

source "https://rubygems.org"

git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }

group :jekyll_plugins do
  gem "github-pages", "= 228"
  gem "jekyll-remote-theme"
  gem "jekyll-include-cache"
  gem "jekyll-sitemap"
  gem "jekyll-feed"
end

I also tried to put gem "github-pages", "= 228" outside of group :jekyll_plugins. It still has same problem.

Dockerfile

I run building in docker container.

ARG RUBY_VERSION=2.7.4
FROM ruby:$RUBY_VERSION-alpine

WORKDIR /src/site
COPY ./Gemfile /src/site/

RUN apk add --no-cache --virtual .build_deps \
  make build-base && \
  bundle install --verbose && \
  apk del .build_deps

ENV LANG en_US.UTF-8
ENV LANGUAGE en_US.UTF-8
ENV LC_ALL en_US.UTF-8

ENTRYPOINT ["jekyll"]
CMD ["serve", "-H", "0.0.0.0", "-P", "4000"]

GH_PAGE_IMAGE=my_gh_page
# build gh-page image
docker build -f ./Dockerfile -t ${GH_PAGE_IMAGE} .
# jekyll serve
docker run -it --rm -p 4000:4000 -v "${PWD}:/src/site" ${GH_PAGE_IMAGE}
# jekyll build
docker run -it --rm -v "${PWD}:/src/site" ${GH_PAGE_IMAGE} build

leviem1 · 2023-02-09T16:59:11Z

@adoyle-h Do you happen to have GitHub pages listed as a plugin in your _config.yml?

adoyle-h · 2023-02-09T17:41:30Z

@adoyle-h Do you happen to have GitHub pages listed as a plugin in your _config.yml?

I tried. But still same issue.

plugins:
  - github-pages
  - jekyll-remote-theme

remote_theme: just-the-docs/just-the-docs

leviem1 · 2023-02-09T18:25:54Z

@adoyle-h I think I ended up just removing remote theme from my plugins section in _config.yml, so in your example just nuke that whole section.

I also had to make sure to list my remote theme as just-the-docs/just-the-docs@main since it used to default to master, but that may have changed.

The deployment of the site using GitHub Pages is not rendered correctly as evidenced by pages without titles appearing in the site navigation and Liquid tags -- specifically output of variables -- appearing rather than the value of the variables. This behavior was confirmed locally when building the site with the github-pages gem. This change removes the github-pages gem from the `:jekyll_plugins` group as suggested in an open issue. References github/pages-gem#657

joel-coffman mentioned this issue Mar 23, 2024

Add github-pages gem joel-coffman/jekyll-course-site#13

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Gem overrides stylesheet after regenerating site #657

Gem overrides stylesheet after regenerating site #657

ashmaroli commented Oct 11, 2019

ashmaroli commented Oct 11, 2019

leviem1 commented Apr 21, 2020 •

edited

adoyle-h commented Feb 9, 2023

leviem1 commented Feb 9, 2023 •

edited

adoyle-h commented Feb 9, 2023

leviem1 commented Feb 9, 2023

Gem overrides stylesheet after regenerating site #657

Gem overrides stylesheet after regenerating site #657

Comments

ashmaroli commented Oct 11, 2019

Summary

This issue affects

Steps to reproduce

What did you expect to happen?

What happened instead?

Before regeneration:

After regeneration:

ashmaroli commented Oct 11, 2019

Workarounds

leviem1 commented Apr 21, 2020 • edited

adoyle-h commented Feb 9, 2023

_config.yml

Gemfile

Dockerfile

leviem1 commented Feb 9, 2023 • edited

adoyle-h commented Feb 9, 2023

leviem1 commented Feb 9, 2023

leviem1 commented Apr 21, 2020 •

edited

leviem1 commented Feb 9, 2023 •

edited