running jekyll locally on a github pages site project

Question

I want to create a project site documentation (not a blog). I create a "project site" github page, as explained in https://pages.github.com, and select the theme 'jekyll-theme-cayman'.

However, when I edit the index.md file in github editor, the preview looks different from the output in my github page (produced by jekyll). I have only two files: _config.yml with the content:

theme: jekyll-theme-cayman

and index.md with the content:

# test
this url is not automatically auto-linked: http://example.com

I installed jekyll in my computer, but it fails as follows when trying to generate the output for my project site:

$ gem install jekyll bundler
$ bundle exec jekyll serve
Configuration file: /private/tmp/test/_config.yml
jekyll 3.6.2 | Error:  The jekyll-theme-cayman theme could not be found.

How can I solve this?

Also, the text http://example.com is auto-linked by default in the github editor, but not in the jekyll output. I read this documentation, and I tried with this _config.yml but it does not work:

theme: jekyll-theme-cayman
markdown: kramdown
kramdown:
  autolink: true

How can I auto-link?

also, the 'jekyll-theme-cayman' theme has a very tall header. how can I configure the theme? does this theme allow to change the header? where can I find the code of the theme and make changes?

marcanuy marcanuy · Accepted Answer · 2017-11-27T12:24:29

Use the github-pages theme (it will prevent other problems and already contains the cayman theme), Gemfile should look like this:

source "https://rubygems.org"

gem "github-pages"

Then: bundle install and bunle exec jekyll s.

To customize the theme follow theme suggestion:

If you'd like to change the theme's HTML layout:

Copy the original template from the theme's repository
(Pro-tip: click "raw" to make copying easier)
Create a file called /_layouts/default.html in your site
Paste the default layout content copied in the first step
Customize the layout as you'd like

autolinks

Autolinks in kramdown are meant to be surrounded by < and > like:

<http://example.com>

<https://example.com>

That would produce the HTML anchor link.

running jekyll locally on a github pages site project

1 Answers

autolinks