Update "Add theme to Pages site"

[DRMPN]

Code of Conduct

• [X] I have read and agree to the GitHub Docs project's Code of Conduct

What article on docs.github.com is affected?

https://docs.github.com/en/pages/setting-up-a-github-pages-site-with-jekyll/adding-a-theme-to-your-github-pages-site-using-jekyll adding-a-theme-to-your-github-pages-site-using-jekyll.md

What changes are you suggesting?

I tried to follow the guide step by step, so I chose a github pages deploy branch, it worked perfectly. The site was up and working as expected. When I tried to install a theme through adding _config.yml file and typed theme: slate I received the error: github-pages 228 | Error: The slate theme could not be found. Well, that's not right, so I tried to set up the source for pages from `GitHub Actions'. Again, received same error:

Configuration file: /github/workspace/./_config.yml
             Theme: slate
github-pages 228 | Error:  The slate theme could not be found.

Since I obviously couldn't do what I wanted, I think you should update this page.

You can see the exact stacktrace by following this link - https://github.com/DRMPN/open-source-ops

Additional information

No response

[welcome[bot]]

Thanks for opening this issue. A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines.

[cmwilson21]

@DRMPN Thanks for opening an issue! After checking in with the team, it looks like the docs could use an update. Try using theme: jekyll-theme-slate instead of theme: slate.

We can update the docs in step 5 of Adding a theme to say theme: jekyll-theme-THEME-NAME.

The same applies to end of that first bullet point, too. Replace theme: minima with theme: jekyll-theme-minima

You or anyone else are welcome to submit a PR with this change 💖

[DRMPN]

It worked! Thank you ❤

I must notify you, that theme: jekyll-theme-minima does not work. It results in the error: github-pages 228 | Error: The jekyll-theme-minima theme could not be found. You can check it here However, after changing the line to theme: minima, the build is successful.

Edit: tested all other themes, and this is the only one that works like this. Logs here.

[cmwilson21]

@DRMPN That's interesting 🤔

So all the themes were successful using theme: jekyll-theme-THEME except for minima that only works with theme: minim. Is am I understanding that correctly? I wonder if it was a bug. Is it still behaving that way or has it been fixed?

[Obeda1995]

اسمع يا صديقي انا لدي بعض الامور انني لا افهم على ما تقول وكيف ساقوم بالغاء تثبيت هل يمكنك بعث لي الرابط الذي ساقوم بالغاء الاشتراك منه وتخلص من هذه الصراع انا لدي وضع خاص وانا متعب جدا وكنت عند والدي في احد المستشفيات يمكن ان تفهمني وانا لا اتكلم الانجليزيه تقريبا

في الاثنين، ١٢ يونيو ٢٠٢٣, ١٠:٤٠ م Courtney Wilson @.***> كتب:

@DRMPN https://github.com/DRMPN That's interesting 🤔

So all the themes were successful using theme: jekyll-theme-THEME except for minima that only works with theme: minim. Is am I understanding that correctly? I wonder if it was a bug. Is it still behaving that way or has it been fixed?

— Reply to this email directly, view it on GitHub https://github.com/github/docs/issues/25314#issuecomment-1587957868, or unsubscribe https://github.com/notifications/unsubscribe-auth/A7EAFFECBYYT27TACPFZO2TXK5WBNANCNFSM6AAAAAAXQZFQTE . You are receiving this because you are subscribed to this thread.Message ID: @.***>

[DRMPN]

@cmwilson21 I have just tried out the following combinations in my config.yml:

• theme: jekyll-theme-minima
• theme: minima
• theme: minim

All the runs have failed:

So I'm guessing that the problem only applies to this particular theme. We may need to do some work on this page as well as the next.

[cmwilson21]

This is starting to sound like a potential bug with Jekyll, then. Would you agree? We can update the docs to reflect the syntax around the themes but I hesitate to make an extra exception for the minima theme. I'll dig around and ask my team, as well.

[DRMPN]

Yes, I agree with you 👍 I would just like to add that this error may only be related to the Minima theme.

[cocorico2005]

I want money

[cmwilson21]

@DRMPN So sorry for the delay on this one! Are you still experiencing the error regarding minima?

If so, would you mind opening an issue in the Jekyll repo? Link to this issue and I will touch base there, as well.

[vgrl]

👋 @DRMPN, since there hasn't been any movement on the issue opened with Jekyll, I suggest we go ahead with a couple of small docs updates. We can make our docs a fraction clearer by referencing a common Jekyll theme and example naming convention in our docs examples, for example jekyll-theme-minimal. 👉 This means let's not specifically mention the Minima theme since it’s naming style is different to most.

Also, it looks like we already only mention a Pages theme in two articles: the one article being discussed here, and then in “Quickstart for GitHub Pages”—in the quickstart we already use jekyll-theme-minimal, so let's do that in our PR too, for consistency.

Furthermore, since we do say where to find the correct theme name to use (that is, in the README of the theme’s repository), and the Jekyll docs do mention the naming convention in the second paragraph here:

(Note that not all themes are using jekyll-theme as a convention in the theme name.)

, we don't need to add a note or make further mention of the Minima theme breaking the naming convention.

I'm going to apply a few small changes to reflect my suggestions above, then I'll double check on preview and get your PR ready to merge if all looks good! ⚡

Thanks for bringing this issue to our attention, and proposing improvements to our docs! 💛