Docs: Quickstart - added documentation about the `--force` option #4410

Merged
merged 2 commits into from Feb 1, 2016

Conversation

Projects
None yet
4 participants
@michaellee
Contributor

michaellee commented Jan 28, 2016

Thought this would be helpful in scenarios where folks want to create a new Jekyll project in an existing folder that is non-empty.

@envygeeks

This comment has been minimized.

Show comment
Hide comment
@envygeeks

envygeeks Jan 28, 2016

Contributor

That's better left as a sub-note with a strong warning rather than a casual fly-by mention.

Contributor

envygeeks commented Jan 28, 2016

That's better left as a sub-note with a strong warning rather than a casual fly-by mention.

site/_docs/quickstart.md
-If you wish to install jekyll into the current directory, you can do so by
-alternatively running `jekyll new .` instead of a new directory name.
+If you wish to install jekyll into an existing directory, you can do so by
+alternatively running `jekyll new .` from within the directory instead of creating a new one. If the existing directory isn't empty, you'll also have to pass the `--force` option like so `jekyll new . --force`.

This comment has been minimized.

@parkr

parkr Jan 28, 2016

Member

Let's remove alternatively. So confusing to me.

@parkr

parkr Jan 28, 2016

Member

Let's remove alternatively. So confusing to me.

@parkr

This comment has been minimized.

Show comment
Hide comment
@parkr

parkr Jan 28, 2016

Member

Thanks, @michaellee! Just one comment. ☝️

Member

parkr commented Jan 28, 2016

Thanks, @michaellee! Just one comment. ☝️

@parkr parkr added the documentation label Jan 28, 2016

@michaellee

This comment has been minimized.

Show comment
Hide comment
@michaellee

michaellee Feb 1, 2016

Contributor

Thanks @envygeeks and @parkr for the feedback. I've removed alternatively from the sentence and pushed up the update.

Contributor

michaellee commented Feb 1, 2016

Thanks @envygeeks and @parkr for the feedback. I've removed alternatively from the sentence and pushed up the update.

@parkr

This comment has been minimized.

Show comment
Hide comment
@parkr

parkr Feb 1, 2016

Member

@jekyllbot: merge +site

Member

parkr commented Feb 1, 2016

@jekyllbot: merge +site

jekyllbot added a commit that referenced this pull request Feb 1, 2016

@jekyllbot jekyllbot merged commit def6330 into jekyll:master Feb 1, 2016

1 check passed

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

jekyllbot added a commit that referenced this pull request Feb 1, 2016

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