I've been trying to use a Jekyll theme from bootstrap called jekyll-theme-clean-blog, and everytime I publish it on Github I receive an email saying, "You are attempting to use a Jekyll theme, "jekyll-theme-clean-blog", which is not supported by GitHub Pages." I tried deleting the "theme" line in my _config.yml, but the page ends up with only the basic HTML and not the template. I have also installed the gem "Jekyll-remote-theme", but it doesn't seem to help. Can someone help me to figure this out?? Or does this mean that I can't use github pages to host the site?? Thank you very much I am a noob.
I found this answer in adding a theme in the help docs, hope it helps. In the _config.yml file:
To use a supported theme, type theme: THEME-NAME, replacing THEME-NAME with the name of the theme as shown in the README of the theme's repository
To use any other Jekyll theme hosted on GitHub, type remote_theme: THEME-NAME, replacing THEME-NAME with the name of the theme as shown in the README of the theme's repository.
Related
I have been able to install most other jekyll themes but this theme in particular I can not get to render. It always shows up just as markdown and never renders the theme. I've had this problem with other themes, usually it involved fixing the url and baseurl in config or some other theme setting.
Theme in question:
https://pmarsceill.github.io/just-the-docs/
I have tried implementing the theme in my own fresh jekyll build.
I have tried cloning the github repository at:
https://github.com/pmarsceill/just-the-docs
I have tried cloning the REALLY basic version using a remote theme:
https://github.com/pmarsceill/jtd-remote
The main thing I want right now is to clone the just-the-docs repository and create a fork that I can just edit, but I can't even get their working repo to work for me. I tried changing the url and baseurl and looked around the files for other things that might make it different for me vs them. Is there anything else I would have to chance?
I expect a rendered theme, I get a white background page with a bunch of text. I have tried copying their exact repo with no sucecess locally with jekyll serve or on github pages on my own repo.
Why is this theme not working when others are?
I was having a similar problem and there has been an issue raised in the repo that seems like what you are describing: https://github.com/pmarsceill/just-the-docs/issues/148
This solved it for me - from a comment there:
I got the same error few days ago, my solution is separate config files for github and local machine. You can view my setup on https://github.com/taruma/hidrokit-nb/tree/master/docs.
For local (_config_local.yml):
# Local Setting
baseurl: ""
url: ""
# Theme
theme: "just-the-docs"
# remote_theme: pmarsceill/just-the-docs
For github (_config.yml):
# Remote Setting
baseurl: "/guidelines"
# url: ""
# Theme
# theme: "just-the-docs"
remote_theme: pmarsceill/just-the-docs
For live server on local machine, I run bundle exec jekyll serve --config _config_local.yml.
I forked some jekyll themes. So I have github io remote on my git account, now. However, I want to replace another theme. is it possible to change?
Yes, it is possible to use custom Jekyll themes.
To build your site with any public, GitHub-hosted theme, add the
following to your site’s _config.yml file:
remote_theme: owner/name
Replacing owner and name with the repository’s owner and name.
How to use custom Jekyll themes in Github pages
I have an existing GitHub project that already had a few html pages. Now I made a GitHub pages site of the project using the docs folder in the master branch but when I try to apply an existing jekyll theme to the pages, the theme is not applied. The docs folder contains a file named index.html.
Do I need to add some kind of import statement to my html pages or do I really need to convert them to markdown syntax? Maybe I am doing something wrong here?
The GitHub project is found here
The GitHub pages site for my project is here
From a plain HTML website to a Jekyll website
If you want a plain html website to use layouts, you start your html pages with:
---
layout: page
---
You can freely rename your files from .html to .md, as it is allright for .md pages to contain HTML. Next you simply create your page.html layout file in the _layouts directory.
Using a Github pages theme
If you want to use a Github theme, you can download the theme and put the files in the root. You can achieve the same by just adding this sinlge line to your _config.yml:
theme: jekyll-theme-hacker
The theme name here is 'jekyll-theme-hacker'. Optionally, if you'd like to preview your site on your computer, add the following to your site's Gemfile:
gem "github-pages", group: :jekyll_plugins
Source: https://github.com/pages-themes/hacker#usage
If you have a _layouts directory containing files with the same name as the new theme layout files, they will have precedence over the theme files.
This is the way Jekyll makes it possible to customize themes.
In this case remove the _layouts directory and Github pages will use the desired theme.
I created a GitHub page with a repository called myusername.github.io
I cloned that (empty) repo to my PC and using jekyll command line I created a new blog inside of this folder. It was building correctly on my PC and on GitHub with the standard theme 'minima'.
However, I wanted to use the 'architect' theme and followed their instructions (just add theme: jekyll-theme-architect on the _config.yml) to use it but got a messed up page as a result. What is going on? How can I fix that?
I am totally pissed off by this. The instruction is so simple, but does not work!!!
This is due to not having the proper gem locally, so you can install the gem explicitely or add the github-pages gem that contains that theme as it is supported by Github pages.
Add the following to your site's Gemfile:
gem "github-pages", group: :jekyll_plugins
then run bundle install.
Edit index.md and change the layout to the default one: layout: default.
Remove the lines that contains an include tag in about.md for example: {% include icon-github.html username="jekyll" %}.
and you will be able to use the new theme.
When I use a dedicated GitHub page to host this blog the theme works, see here.
However, what I want to do is create this blog as a "Project Page", i.e. a subpage of an organization, in this way.
I've been following the tutorial on how to create a gh-pages branch, provided by GitHub themselves.
In conjunction with the "Host on GitHub in 3 Minutes" tutorial from Jekyll.
I can get it up and running with the basic out-of-the-box theme, but I want to use the "twitter theme", but when I followed the command to install it, i.e. rake theme:install git="https://github.com/jekyllbootstrap/theme-twitter.git" and then pushed to the gh-pages branch, it just completely stripped away all the formatting and now there is no theme at all, see here.
Why did that happen? How can I fix it?
As usual it's a baseurl problem. In _config.yml : set
baseurl: /Description-Logicians-of-EIS
or BASE_PATH if you use Jekyll Bootstrap
If you open up the console in your browser (ctrl + J), you can see the CSS fails to load with a 404.
Failed to load resource: the server responded with a status of 404 (Not Found)
http://eis-bonn.github.io/assets/themes/twitter/css/1.4.0/bootstrap.css
That's probably a good starting point. Where are your css files stored?
Spoiler Alert!
When I visit your repository, the directory pointed to in your header is missing. Instead I find Bootstrap in an entirely different directory.