New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update the configuration docs to match the code #5131

Merged
merged 1 commit into from Jul 25, 2016

Conversation

Projects
None yet
4 participants
@stevecheckoway
Contributor

stevecheckoway commented Jul 25, 2016

The current documentation of the default options is wrong. I've tried to make them agree. The major things

  • coderay is no longer in the defaults
  • kramdown's input: GFM is already the default so I removed the section talking about adding it
  • I added documentation for liquid's error_mode
plugins_dir: _plugins
layouts_dir: _layouts
data_dir: _data
includes_dir: _includes

This comment has been minimized.

@parkr

parkr Jul 25, 2016

Member

Why change these but not modify ./_site?

@parkr

parkr Jul 25, 2016

Member

Why change these but not modify ./_site?

This comment has been minimized.

@stevecheckoway

stevecheckoway Jul 25, 2016

Contributor

The definition for destination seems correct. It's not relative to source the way the others are.

    DEFAULTS = Configuration[{
      # Where things are
      "source"            => Dir.pwd,
      "destination"       => File.join(Dir.pwd, "_site"),
      "plugins_dir"       => "_plugins",
      "layouts_dir"       => "_layouts",
      "data_dir"          => "_data",
      "includes_dir"      => "_includes",
      "collections"       => {},
@stevecheckoway

stevecheckoway Jul 25, 2016

Contributor

The definition for destination seems correct. It's not relative to source the way the others are.

    DEFAULTS = Configuration[{
      # Where things are
      "source"            => Dir.pwd,
      "destination"       => File.join(Dir.pwd, "_site"),
      "plugins_dir"       => "_plugins",
      "layouts_dir"       => "_layouts",
      "data_dir"          => "_data",
      "includes_dir"      => "_includes",
      "collections"       => {},

This comment has been minimized.

@parkr

parkr Jul 25, 2016

Member

They're resolved using Jekyll.sanitized_path(site.source, the_dir) so it shakes out to be the same. :shrug:

@parkr

parkr Jul 25, 2016

Member

They're resolved using Jekyll.sanitized_path(site.source, the_dir) so it shakes out to be the same. :shrug:

Show outdated Hide outdated site/_docs/configuration.md Outdated
@parkr

This comment has been minimized.

Show comment
Hide comment
@parkr

parkr Jul 25, 2016

Member

Other than my two comments above, LGTM.

Member

parkr commented Jul 25, 2016

Other than my two comments above, LGTM.

@stevecheckoway

This comment has been minimized.

Show comment
Hide comment
@stevecheckoway

stevecheckoway Jul 25, 2016

Contributor

New version addresses the comment about posts.

Contributor

stevecheckoway commented Jul 25, 2016

New version addresses the comment about posts.

@parkr parkr changed the title from Make the documentation match the code. to Update the configuration docs to match the code Jul 25, 2016

@parkr

This comment has been minimized.

Show comment
Hide comment
@parkr

parkr Jul 25, 2016

Member

LGTM.

@jekyllbot: merge +site

Member

parkr commented Jul 25, 2016

LGTM.

@jekyllbot: merge +site

@jekyllbot jekyllbot merged commit 5e3f9cd into jekyll:master Jul 25, 2016

0 of 3 checks passed

continuous-integration/appveyor/pr AppVeyor build failed
Details
jekyll/lgtm Awaiting approval from at least 2 maintainers.
continuous-integration/travis-ci/pr The Travis CI build is in progress
Details

jekyllbot added a commit that referenced this pull request Jul 25, 2016

@stevecheckoway stevecheckoway deleted the stevecheckoway:default-docs branch Jul 25, 2016

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment