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:
this url is not automatically auto-linked: http://example.com
$ 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.
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"
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 in kramdown are meant to be surrounded by
That would produce the HTML anchor link.