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

Add 'jekyll help' command. #2707

Merged
merged 3 commits into from Aug 9, 2014

Conversation

Projects
None yet
3 participants
@parkr
Member

parkr commented Aug 7, 2014

Addresses one issue of #2695.

Presently, if you just enter jekyll help, you'll see the normal jekyll --help message. I think this makes sense. An alternative is to require a subcommand.

Usage:

$ jekyll help
jekyll 2.2.0 -- Jekyll is a blog-aware, static site generator in Ruby

Usage:

  jekyll <subcommand> [options]

Options:
        -s, --source [DIR]  Source directory (defaults to ./)
        -d, --destination [DIR]  Destination directory (defaults to ./_site)
            --safe         Safe mode (defaults to false)
        -p, --plugins PLUGINS_DIR1[,PLUGINS_DIR2[,...]]  Plugins directory (defaults to ./_plugins)
            --layouts DIR  Layouts directory (defaults to ./_layouts)
        -h, --help         Show this message
        -v, --version      Print the name and version
        -t, --trace        Show the full backtrace when an error occurs

Subcommands:
  build                 Build your site
  docs                  Launch local server with docs for Jekyll v2.2.0
  doctor, hyde          Search site and print specific deprecation warnings
  help                  Show the help message, optionally for a given subcommand.
  new                   Creates a new Jekyll site scaffold in PATH
  serve, server         Serve your site locally
$ jekyll help serve
jekyll serve -- Serve your site locally

Usage:

  jekyll serve [options]

Options:
            --config CONFIG_FILE[,CONFIG_FILE2,...]  Custom configuration file
            --future       Publishes posts with a future date
            --limit_posts MAX_POSTS  Limits the number of posts to parse and publish
        -w, --watch        Watch for changes and rebuild
            --force_polling  Force watch to use polling
            --lsi          Use LSI for improved related posts
        -D, --drafts       Render posts in the _drafts folder
            --unpublished  Render posts that were marked as unpublished
        -q, --quiet        Silence output.
        -V, --verbose      Print verbose output.
        -B, --detach       Run the server in the background (detach)
        -P, --port [PORT]  Port to listen on
        -H, --host [HOST]  Host to bind to
        -b, --baseurl [URL]  Base URL
            --skip-initial-build  Skips the initial site build which occurs before the server is started.

@parkr parkr added the UX label Aug 7, 2014

@parkr parkr self-assigned this Aug 7, 2014

@mattr-

This comment has been minimized.

Show comment
Hide comment
@mattr-

mattr- Aug 9, 2014

Member

Seems good. :shipit:

Member

mattr- commented Aug 9, 2014

Seems good. :shipit:

parkr added a commit that referenced this pull request Aug 9, 2014

@parkr parkr merged commit d4fbf5c into master Aug 9, 2014

1 check passed

continuous-integration/travis-ci The Travis CI build passed
Details

@parkr parkr deleted the jekyll-help branch Aug 9, 2014

parkr added a commit that referenced this pull request Aug 9, 2014

@jekyll jekyll locked and limited conversation to collaborators Feb 27, 2017

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