在github pages站点项目上本地运行jekyll

时间:2017-11-27 10:21:16

标签: markdown jekyll github-pages

我想创建一个项目站点文档(而不是博客)。 我创建了一个"项目网站" github页面,如https://pages.github.com中所述,并选择主题' jekyll-theme-cayman'。

但是,当我在github编辑器中编辑index.md文件时,预览看起来与我的github页面中的输出(由jekyll生成)不同。我只有两个文件:_config.yml,内容为:

theme: jekyll-theme-cayman
带有内容的

index.md

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

我在我的计算机上安装了jekyll,但在尝试为我的项目站点生成输出时,它失败如下:

$ 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.

我该如何解决这个问题?

此外,文本http://example.com默认情况下在github编辑器中自动链接,但不在jekyll输出中。我看过this documentation,我尝试使用此_config.yml,但它不起作用:

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

如何自动链接?

此外,' jekyll-theme-cayman'主题有一个很高的标题。我该如何配置主题?这个主题是否允许更改标题?我在哪里可以找到主题的代码并进行更改?

1 个答案:

答案 0 :(得分:3)

使用github-pages主题(它会阻止其他问题,并且已经包含了cayman主题),PERCENTILE()应该如下所示:

Gemfile

然后:source "https://rubygems.org" gem "github-pages" bundle install

要自定义主题,请按照主题建议:

  

如果您想更改主题的HTML布局:

bunle exec jekyll s

自动连结

kramdown中的自动链接应由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 <包围,如:

>

这将产生HTML锚链接。