Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Install instructions may no longer be accurate #37

Open
at88mph opened this issue Dec 8, 2022 · 2 comments · May be fixed by #38
Open

Install instructions may no longer be accurate #37

at88mph opened this issue Dec 8, 2022 · 2 comments · May be fixed by #38

Comments

@at88mph
Copy link

at88mph commented Dec 8, 2022

Describe the bug
The current install instructions of adding:
theme: jekyll-theme-gcweb

To the _config.yml file gives an error:
jekyll 3.8.7 | Error: The jekyll-theme-gcweb theme could not be found.

To Reproduce
Steps to reproduce the behavior:

  1. Open the _config.yml file
  2. Add theme: jekyll-theme-gcweb
  3. Build with Jekyll: jekyll build

Expected behavior
Error free installation

Desktop (please complete the following information):

  • OS: Linux, MacOS
  • Version 0.1.0

Additional context
Adding:
gem "gcweb-jekyll", "~> 0.1.0", git: "https://github.com/wet-boew/gcweb-jekyll"
to the Gemfile fixed it, as well as:
theme: gcweb-jekyll # not jekyll-theme-gcweb
to the _config.yml fixes this.

However, adding gcweb-jekyll from GitHub is risky as it's not necessarily a release. Is there a different way to do this?
at88mph added a commit to at88mph/gcweb-jekyll that referenced this issue Dec 9, 2022
@at88mph
Fixes wet-boew#37
5c15834
@at88mph
Copy link
Author

at88mph commented Dec 9, 2022

I managed to work this with remote_theme instead, which I guess essentially does the same thing.

@delisma
Copy link

delisma commented Dec 9, 2022

@at88mph These instructions are definitely out of date! We're working on improving the developer experience for the GCWeb-Jekyll, with appropriate translated documentation and all.

@delisma delisma linked a pull request Dec 9, 2022 that will close this issue
Fixes #37 #38
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Fixes #37 at88mph/gcweb-jekyll
2 participants
@at88mph @delisma