mirror of
https://github.com/jekyll/jekyll.git
synced 2026-01-30 17:28:29 -05:00
5647a902de
Since the highlighter configuration option should default to pygments, we don't have to explicitly set it in the step testing the output with pygments.
267 lines
13 KiB
Gherkin
267 lines
13 KiB
Gherkin
Feature: Site configuration
|
|
As a hacker who likes to blog
|
|
I want to be able to configure jekyll
|
|
In order to make setting up a site easier
|
|
|
|
Scenario: Change source directory
|
|
Given I have a blank site in "_sourcedir"
|
|
And I have an "_sourcedir/index.html" file that contains "Changing source directory"
|
|
And I have a configuration file with "source" set to "_sourcedir"
|
|
When I run jekyll
|
|
Then the _site directory should exist
|
|
And I should see "Changing source directory" in "_site/index.html"
|
|
|
|
Scenario: Change destination directory
|
|
Given I have an "index.html" file that contains "Changing destination directory"
|
|
And I have a configuration file with "destination" set to "_mysite"
|
|
When I run jekyll
|
|
Then the _mysite directory should exist
|
|
And I should see "Changing destination directory" in "_mysite/index.html"
|
|
|
|
Scenario Outline: Similarly named source and destination
|
|
Given I have a blank site in "<source>"
|
|
And I have an "<source>/index.md" page that contains "markdown"
|
|
And I have a configuration file with:
|
|
| key | value |
|
|
| source | <source> |
|
|
| destination | <dest> |
|
|
When I run jekyll
|
|
Then the <source> directory should exist
|
|
And the "<dest>/index.html" file should <file_exist> exist
|
|
And I should see "markdown" in "<source>/index.md"
|
|
|
|
Examples:
|
|
| source | dest | file_exist |
|
|
| mysite_source | mysite | |
|
|
| mysite | mysite_dest | |
|
|
| mysite/ | mysite | not |
|
|
| mysite | ./mysite | not |
|
|
| mysite/source | mysite | not |
|
|
| mysite | mysite/dest | |
|
|
|
|
Scenario: Exclude files inline
|
|
Given I have an "Rakefile" file that contains "I want to be excluded"
|
|
And I have an "README" file that contains "I want to be excluded"
|
|
And I have an "index.html" file that contains "I want to be included"
|
|
And I have a configuration file with "exclude" set to "['Rakefile', 'README']"
|
|
When I run jekyll
|
|
Then I should see "I want to be included" in "_site/index.html"
|
|
And the "_site/Rakefile" file should not exist
|
|
And the "_site/README" file should not exist
|
|
|
|
Scenario: Exclude files with YAML array
|
|
Given I have an "Rakefile" file that contains "I want to be excluded"
|
|
And I have an "README" file that contains "I want to be excluded"
|
|
And I have an "index.html" file that contains "I want to be included"
|
|
And I have a configuration file with "exclude" set to:
|
|
| value |
|
|
| README |
|
|
| Rakefile |
|
|
When I run jekyll
|
|
Then I should see "I want to be included" in "_site/index.html"
|
|
And the "_site/Rakefile" file should not exist
|
|
And the "_site/README" file should not exist
|
|
|
|
Scenario: Use RDiscount for markup
|
|
Given I have an "index.markdown" page that contains "[Google](http://google.com)"
|
|
And I have a configuration file with "markdown" set to "rdiscount"
|
|
When I run jekyll
|
|
Then the _site directory should exist
|
|
And I should see "<a href=\"http://google.com\">Google</a>" in "_site/index.html"
|
|
|
|
Scenario: Use Kramdown for markup
|
|
Given I have an "index.markdown" page that contains "[Google](http://google.com)"
|
|
And I have a configuration file with "markdown" set to "kramdown"
|
|
When I run jekyll
|
|
Then the _site directory should exist
|
|
And I should see "<a href=\"http://google.com\">Google</a>" in "_site/index.html"
|
|
|
|
Scenario: Use Redcarpet for markup
|
|
Given I have an "index.markdown" page that contains "[Google](http://google.com)"
|
|
And I have a configuration file with "markdown" set to "redcarpet"
|
|
When I run jekyll
|
|
Then the _site directory should exist
|
|
And I should see "<a href=\"http://google.com\">Google</a>" in "_site/index.html"
|
|
|
|
Scenario: Use Maruku for markup
|
|
Given I have an "index.markdown" page that contains "[Google](http://google.com)"
|
|
And I have a configuration file with "markdown" set to "maruku"
|
|
When I run jekyll
|
|
Then the _site directory should exist
|
|
And I should see "<a href=\"http://google.com\">Google</a>" in "_site/index.html"
|
|
|
|
Scenario: Highlight code with pygments
|
|
Given I have an "index.html" page that contains "{% highlight ruby %} puts 'Hello world!' {% endhighlight %}"
|
|
When I run jekyll
|
|
Then the _site directory should exist
|
|
And I should see "Hello world!" in "_site/index.html"
|
|
And I should see "class=\"highlight\"" in "_site/index.html"
|
|
|
|
Scenario: Highlight code with rouge
|
|
Given I have an "index.html" page that contains "{% highlight ruby %} puts 'Hello world!' {% endhighlight %}"
|
|
And I have a configuration file with "highlighter" set to "rouge"
|
|
When I run jekyll
|
|
Then the _site directory should exist
|
|
And I should see "Hello world!" in "_site/index.html"
|
|
And I should see "class=\"highlight\"" in "_site/index.html"
|
|
|
|
Scenario: Set time and no future dated posts
|
|
Given I have a _layouts directory
|
|
And I have a page layout that contains "Page Layout: {{ site.posts.size }} on {{ site.time | date: "%Y-%m-%d" }}"
|
|
And I have a post layout that contains "Post Layout: {{ content }}"
|
|
And I have an "index.html" page with layout "page" that contains "site index page"
|
|
And I have a configuration file with:
|
|
| key | value |
|
|
| time | 2010-01-01 |
|
|
| future | false |
|
|
And I have a _posts directory
|
|
And I have the following posts:
|
|
| title | date | layout | content |
|
|
| entry1 | 2007-12-31 | post | content for entry1. |
|
|
| entry2 | 2020-01-31 | post | content for entry2. |
|
|
When I run jekyll
|
|
Then the _site directory should exist
|
|
And I should see "Page Layout: 1 on 2010-01-01" in "_site/index.html"
|
|
And I should see "Post Layout: <p>content for entry1.</p>" in "_site/2007/12/31/entry1.html"
|
|
And the "_site/2020/01/31/entry2.html" file should not exist
|
|
|
|
Scenario: Set time and future dated posts allowed
|
|
Given I have a _layouts directory
|
|
And I have a page layout that contains "Page Layout: {{ site.posts.size }} on {{ site.time | date: "%Y-%m-%d" }}"
|
|
And I have a post layout that contains "Post Layout: {{ content }}"
|
|
And I have an "index.html" page with layout "page" that contains "site index page"
|
|
And I have a configuration file with:
|
|
| key | value |
|
|
| time | 2010-01-01 |
|
|
| future | true |
|
|
And I have a _posts directory
|
|
And I have the following posts:
|
|
| title | date | layout | content |
|
|
| entry1 | 2007-12-31 | post | content for entry1. |
|
|
| entry2 | 2020-01-31 | post | content for entry2. |
|
|
When I run jekyll
|
|
Then the _site directory should exist
|
|
And I should see "Page Layout: 2 on 2010-01-01" in "_site/index.html"
|
|
And I should see "Post Layout: <p>content for entry1.</p>" in "_site/2007/12/31/entry1.html"
|
|
And I should see "Post Layout: <p>content for entry2.</p>" in "_site/2020/01/31/entry2.html"
|
|
|
|
Scenario: Generate proper dates with explicitly set timezone (same as posts' time)
|
|
Given I have a _layouts directory
|
|
And I have a page layout that contains "Page Layout: {{ site.posts.size }}"
|
|
And I have a post layout that contains "Post Layout: {{ content }} built at {{ page.date | date_to_xmlschema }}"
|
|
And I have an "index.html" page with layout "page" that contains "site index page"
|
|
And I have a configuration file with:
|
|
| key | value |
|
|
| timezone | America/New_York |
|
|
And I have a _posts directory
|
|
And I have the following posts:
|
|
| title | date | layout | content |
|
|
| entry1 | 2013-04-09 23:22 -0400 | post | content for entry1. |
|
|
| entry2 | 2013-04-10 03:14 -0400 | post | content for entry2. |
|
|
When I run jekyll
|
|
Then the _site directory should exist
|
|
And I should see "Page Layout: 2" in "_site/index.html"
|
|
And I should see "Post Layout: <p>content for entry1.</p> built at 2013-04-09T23:22:00-04:00" in "_site/2013/04/09/entry1.html"
|
|
And I should see "Post Layout: <p>content for entry2.</p> built at 2013-04-10T03:14:00-04:00" in "_site/2013/04/10/entry2.html"
|
|
|
|
Scenario: Generate proper dates with explicitly set timezone (different than posts' time)
|
|
Given I have a _layouts directory
|
|
And I have a page layout that contains "Page Layout: {{ site.posts.size }}"
|
|
And I have a post layout that contains "Post Layout: {{ content }} built at {{ page.date | date_to_xmlschema }}"
|
|
And I have an "index.html" page with layout "page" that contains "site index page"
|
|
And I have a configuration file with:
|
|
| key | value |
|
|
| timezone | Australia/Melbourne |
|
|
And I have a _posts directory
|
|
And I have the following posts:
|
|
| title | date | layout | content |
|
|
| entry1 | 2013-04-09 23:22 -0400 | post | content for entry1. |
|
|
| entry2 | 2013-04-10 03:14 -0400 | post | content for entry2. |
|
|
When I run jekyll
|
|
Then the _site directory should exist
|
|
And I should see "Page Layout: 2" in "_site/index.html"
|
|
And the "_site/2013/04/10/entry1.html" file should exist
|
|
And the "_site/2013/04/10/entry2.html" file should exist
|
|
And I should see escaped "Post Layout: <p>content for entry1.</p> built at 2013-04-10T13:22:00+10:00" in "_site/2013/04/10/entry1.html"
|
|
And I should see escaped "Post Layout: <p>content for entry2.</p> built at 2013-04-10T17:14:00+10:00" in "_site/2013/04/10/entry2.html"
|
|
|
|
Scenario: Limit the number of posts generated by most recent date
|
|
Given I have a _posts directory
|
|
And I have a configuration file with:
|
|
| key | value |
|
|
| limit_posts | 2 |
|
|
And I have the following posts:
|
|
| title | date | content |
|
|
| Apples | 2009-03-27 | An article about apples |
|
|
| Oranges | 2009-04-01 | An article about oranges |
|
|
| Bananas | 2009-04-05 | An article about bananas |
|
|
When I run jekyll
|
|
Then the _site directory should exist
|
|
And the "_site/2009/04/05/bananas.html" file should exist
|
|
And the "_site/2009/04/01/oranges.html" file should exist
|
|
And the "_site/2009/03/27/apples.html" file should not exist
|
|
|
|
Scenario: Copy over normally excluded files when they are explicitly included
|
|
Given I have a ".gitignore" file that contains ".DS_Store"
|
|
And I have an ".htaccess" file that contains "SomeDirective"
|
|
And I have a configuration file with "include" set to:
|
|
| value |
|
|
| .gitignore |
|
|
| .foo |
|
|
When I run jekyll
|
|
Then the _site directory should exist
|
|
And I should see ".DS_Store" in "_site/.gitignore"
|
|
And the "_site/.htaccess" file should not exist
|
|
|
|
Scenario: Using a different layouts directory
|
|
Given I have a _theme directory
|
|
And I have a page theme that contains "Page Layout: {{ site.posts.size }} on {{ site.time | date: "%Y-%m-%d" }}"
|
|
And I have a post theme that contains "Post Layout: {{ content }}"
|
|
And I have an "index.html" page with layout "page" that contains "site index page"
|
|
And I have a configuration file with:
|
|
| key | value |
|
|
| time | 2010-01-01 |
|
|
| future | true |
|
|
| layouts | _theme |
|
|
And I have a _posts directory
|
|
And I have the following posts:
|
|
| title | date | layout | content |
|
|
| entry1 | 2007-12-31 | post | content for entry1. |
|
|
| entry2 | 2020-01-31 | post | content for entry2. |
|
|
When I run jekyll
|
|
Then the _site directory should exist
|
|
And I should see "Page Layout: 2 on 2010-01-01" in "_site/index.html"
|
|
And I should see "Post Layout: <p>content for entry1.</p>" in "_site/2007/12/31/entry1.html"
|
|
And I should see "Post Layout: <p>content for entry2.</p>" in "_site/2020/01/31/entry2.html"
|
|
|
|
Scenario: Add a gem-based plugin
|
|
Given I have an "index.html" file that contains "Whatever"
|
|
And I have a configuration file with "gems" set to "[jekyll_test_plugin]"
|
|
When I run jekyll
|
|
Then the _site directory should exist
|
|
And I should see "Whatever" in "_site/index.html"
|
|
And I should see "this is a test" in "_site/test.txt"
|
|
|
|
Scenario: Add an empty whitelist to restrict all gems
|
|
Given I have an "index.html" file that contains "Whatever"
|
|
And I have a configuration file with:
|
|
| key | value |
|
|
| gems | [jekyll_test_plugin] |
|
|
| whitelist | [] |
|
|
When I run jekyll in safe mode
|
|
Then the _site directory should exist
|
|
And I should see "Whatever" in "_site/index.html"
|
|
And the "_site/test.txt" file should not exist
|
|
|
|
Scenario: Add a whitelist to restrict some gems but allow others
|
|
Given I have an "index.html" file that contains "Whatever"
|
|
And I have a configuration file with:
|
|
| key | value |
|
|
| gems | [jekyll_test_plugin, jekyll_test_plugin_malicious] |
|
|
| whitelist | [jekyll_test_plugin] |
|
|
When I run jekyll in safe mode
|
|
Then the _site directory should exist
|
|
And I should see "Whatever" in "_site/index.html"
|
|
And the "_site/test.txt" file should exist
|
|
And I should see "this is a test" in "_site/test.txt"
|