How do I install one of Github Pages' Jekyll themes for local preview? - jekyll

I'm trying to install Github Pages' Slate theme on my CentOS 7 VM so I can locally preview my new site using the bundle exec jekyll serve command.
I followed the instructions as best as I could.
I changed the theme minima to jekyll-theme-slate in my _config.yml file.
Then I changed gem "minima", "~> 2.0" to gem "github-pages", group: :jekyll_plugins in my Gemfile file.
After that (since these are their only instructions), I ran bundle exec jekyll serve and it told me I had gems that weren't installed (duh), and suggested running bundle install.
I ran bundle install, which told me there was a conflict in version types of the dependencies and it suggested that bundle update could potentially resolve that issue.
No problem, I ran bundle update. A few plugins/features actually reverted versions here, but I got the Slate theme installed on my machine now, version 0.0.4 for whatever reason.
After that, I ran bundle exec jekyll serve again. I got this error:
Configuration file: /home/peri/my-site/_config.yml
Configuration file: /home/peri/my-site/_config.yml
jekyll 3.4.3 | Error: Could not find a JavaScript runtime. See https://github.com/rails/execjs for a list of available runtimes.
In a way, that error makes sense. For a custom theme to work, I probably need a tool to run their custom scripts. But first, I noticed this extra section in the theme's installation instructions, which directly mentions being able to locally preview the site with that theme.
I downloaded the source, instead of cloning it...I don't need the .git stuff do I?
I edited the script/bootstrap file because /usr/local requires root and using sudo doesn't know about any binary called gem or bundle. I changed gem and bundle to their respective absolute paths and ran sudo ./script/bootstrap inside of slate-master.
Point of the story is, it didn't work for my home/peri/my-site directory when I ran bundle exec jekyll serve. Presumably, it's because they intended for the user's site to be integrated into their theme's source code? That doesn't seem intuitive or correct. So, I investigated ExecJS.
I installed it. gem install execjs
I added gem "execjs", "2.7.0" to my Gemfile file.
Got the same error as before.
How am I supposed to install this Jekyll theme?

Follow these steps after changing the theme in _config.yml:
Gemfile should have only this content:
source "https://rubygems.org"
gem "github-pages"
remove bundler current config: rm -r .bundle/
remove Gemfile.lock: rm Gemfile.lock
Install local dependencies in an isolated folder just for this website: bundle install --path=vendor/bundle
You won't have post and page and home themes, you will need to use just default in all your posts.
Generate and run server: bundle exec jekyll s

Related

Jekyll plugin works locally but not on Travis CI

I've set up my site to build with Travis CI, and added a few plugins.
This is my Gemfile:
source "https://rubygems.org"
group :jekyll_plugins do
gem "github-pages"
gem "octopress-minify-html" # This one does not work on Travis
gem "jekyll-git_metadata"
gem "jekyll-paginate-v2"
gem "jekyll-tagging"
end
And this is my .travis.yml (with irrelevant information stripped)
language: ruby
cache: bundler
sudo: false
#install: use default `bundle install`
script: bundle exec jekyll build
after_success: .travis/deploy.sh
I tried building my site locally:
$ bundle update
$ bundle install
$ bundle exec jekyll build
And I can see the generated HTML files are minified.
But when I check pushed files from Travis CI, the HTML files are not minified. Also judging from build time, the plugin octopress-minify-html is not working (when it's working the build time is significantly longer).
I tried deleting my whole working directory and re-cloning from GitHub and this plugin is still working locally. I deleted Travis CI cache and let Bundler build everything again, but the plugin still doesn't work on Travis.
What went wrong on Travis?
You can force minification with octopress-minify-html by setting minify_html: true in your config file.

what exactly is build the site (jekyll)?

this's a super noob question but, what exactly is "build the site" running this command:
`~/myblog $ bundle exec jekyll serve`
is this to start the server?, because I'm currently using $ jekyll serve :s
As mentioned in its Quick-start guide, this command will build the site on the preview server.
Update:
There is a difference between jekyll serve and bundle exec jekyll serve:
The Gemfile and Gemfile.lock files inform Bundler about the gem requirements in your site. If your site doesn’t have these Gemfiles, you can omit bundle exec and just run jekyll serve.
When you run bundle exec jekyll serve, Bundler uses the gems and versions as specified in Gemfile.lock to ensure your Jekyll site builds with no compatibility or dependency conflicts.
Update 2:
In simple words, "build the site" means the Bundler will use the gems and versions specified in Gemfile.lock to ensure your Jekyll site builds with no compatibility or dependency conflicts and then will run your site on the preview or local server.
The serve command is actually an extension of the build command.
i.e., when a Jekyll user runs jekyll serve or bundle exec jekyll serve, Jekyll first runs the jekyll build command internally and then starts the local server to host the generated site.
So what exactly is this build the site? Well, Jekyll being a static-site generator generates your site using the build command.
Therefore, whether you run jekyll build or jekyll serve, a default jekyll site gets built or generated into the ./_site folder. The minor difference with running the serve command being Jekyll will proceed to start a local web-server and mount the built / generated site onto the server so that you can navigate the site via http://localhost:4000

Jekyll 3.0 run on localhost:4000 error

Recently, I upgrade my jekyll server from 2.5 to 3.0 , However, it occur a problem:
i render my page on gitpage that is very successful, but when i render it on my local jekyll server, there has a error
my every post's route is /category/YYYY/MM/DD/postName.html (The category is chinese)
At the git page it was no problem
but when i use the localhost server , when i cilck these post anchors , It show no find this html file , and redirect to the 404.html
On local anchors's href such as http://localhost:4000/%E6%8A%80%E6%9C%AF/2016/04/04/array-function.html
and on the git page the href is http://numerhero.github.io/%E6%8A%80%E6%9C%AF/2016/04/04/array-function.html
it was my gitpage address , no any problem : http://numerhero.github.io
Try this:
Install Bundler gem install bundler
Navigate to your project's root cd path/to/project
Run bundle init (will create a Gemfile)
Edit your Gemfile:
source 'https://rubygems.org'
gem 'github-pages'
Run bundle install
Run bundle update (once and awhile)
Serve Jekyll with Bundler: bundle exec jekyll serve
Done!
Your problem must be related to your local dependencies, which must be different than GitHub Pages'. With Bundler, a dependency manager, you will make sure you have github-pages and all it's dependencies installed locally.
Run bundle update once and awhile to make sure you have the last versions installed.
Read more about upgrading Jekyll 2 to 3 here:
http://blog.virtuacreative.com.br/upgrade-jekyll-2-to-3-gh-pages.html

Jekyll install on Windows error message

I think I'm just at the finish line for installing jekyll on windows, It's connecting fine, but I'm getting an error message:
Liquid exception: No such file or directory - python C:/Ruby193/lib/ruby/ms/1.9.1/gems/pygments.rb-0.6.3/lib/pygments/mentos.py in _posts/2015-06-09-welcome-to-jekyll.markdown<-[0m done.
Please add the following to your Gemfile to avoid polling for changes: gem 'wdm','>=0.1.0' if Gem.win_platform
I'm not sure what messages I can ignore and what I need to fix. What do you guys think?
If adding this to my gemfile is as simple as entering a cmd prompt, what do I need to enter to install it?
This was an issue that was addressed by me by another question a few days ago.This is the original question and my answer.
Basically the issue here is that you need to install Python to use Jekyll on Windows because the code highlighter Pygments is written in Python, hence requires Python to function. Pygments is alsothe default code highlighter currently. In the future versions of Jekyll will use the Rouge highlighter, which is written completely in Ruby. This issue is tracked on GitHub.
To solve your current problem, you just need to install Python 2.x, which the official linked guide from the Jekyll documentation provides very clear instructions there. You will also need to install pip. I have also included alternatives in the other SO answer I have given, so I will just provide you the link to it to reduce duplicate information and copy-paste.
Once you have Python 2.x and pip set up, and install pygments, your Jekyll install should be up and running with the site template!
Regarding the Gemfile
A summary of what a Gemfile is: A file that lists all the required Ruby gems for a particular program. For example, you wrote a ruby program that depends on 10 other gems, rather than ask the user of your new gem to go download the previous 10 gems, and then later wrestle with outdated gem issues, a Gemfile is used to keep track of what gems are needed and version. The Gemfile is used by Bundler, which is also a gem that automatically keeps track of what gems you need. In the case of Jekyll, you can use a Gemfile to dictate what you want added into your Jekyll install or removed. This is used by GitHub to keep local versions of Jekyll and other gems updated with the version used by Github Pages.
As for that notification, all you would need to do to avoid polling for changes is:
Open notepad or text editor of choice.
Add this line: gem 'wdm','>=0.1.0' if Gem.win_platform, just that line of text. You can later add gems by typing in gem 'nameOfGem in a separate line.
Save the file as Gemfile in your Jekyll site's folder. Notice that there is not .txt extension, which you can create a file with no extension in notepad by choosing 'All Files' instead of '.txt' under 'Save As'. Or, you could just edit the file extension to remove the .txt.
Install bundler by executing gem install bundler.
Run bundle install to update the gems. If you're using GitHub, add the Gemfile and the newly generated Gemfile.lock into git.

Jekyll serve -w Issue

I am using the jekyll with git-hub-pages on Win7, however no matter what I do the
jekyll serve --watch or
jekyll serve -w
won't start the server (the jekyll serve is working fine).
the produced error has something to do with
custom_require.rb:36 - cannot load such a file --wdm
How can I fix it?
As shown in the error message, wdm is not found.
First, update your gems
gem update
Then, manually install wdm
gem install wdm