Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Remove references to the watch command in the docs #2954

Merged
merged 3 commits into from
Sep 27, 2014
Merged

Remove references to the watch command in the docs #2954

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f80d82c
Remove references to the watch command in the sample
chrisfinazzo Sep 26, 2014
bec32b1
Add a note about the separate commands, show an example without the w…
chrisfinazzo Sep 27, 2014
4a5f70b
Clarify instructions
chrisfinazzo Sep 27, 2014
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 13 additions & 3 deletions site/_docs/usage.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,14 +41,24 @@ preview what the generated site will look like in your browser locally.
{% highlight bash %}
$ jekyll serve
# => A development server will run at http://localhost:4000/
# Auto-regeneration: enabled. Use `--no-watch` to disable.

$ jekyll serve --detach
# => Same as `jekyll serve` but will detach from the current terminal.
# If you need to kill the server, you can `kill -9 1234` where "1234" is the PID.
# If you cannot find the PID, then do, `ps aux | grep jekyll` and kill the instance. [Read more](http://unixhelp.ed.ac.uk/shell/jobz5.html).
{% endhighlight %}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe change this to jekyll serve --no-watch?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Either way is fine. It depends on how verbose you think it needs to be.

FWIW, I usually just wrap the commands in a test.sh script and run it that way, so --watch is not a switch I flip frequently (Default behavior is enabled).

If you can think of a use case where a separate command makes sense, go for it.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we should show an example with --no-watch so it's obvious that it exists. We should also add a note to jekyll serve that says it automatically regenerates.


<div class="note info">
<h5>Be aware of default behavior</h5>
<p>
As of version 2.4, the <code>serve</code> command will watch for changes automatically. To disable this, you can use <code>jekyll serve --no-watch</code>, which preserves the old behavior.
</p>
</div>

$ jekyll serve --watch
# => Same as `jekyll serve`, but watch for changes and regenerate automatically.
{% highlight bash %}
$ jekyll serve --no-watch
# => Same as `jekyll serve` but will not watch for changes.
{% endhighlight %}

These are just a few of the available [configuration options](../configuration/).
Expand All @@ -71,4 +81,4 @@ $ jekyll build --source _source --destination _deploy
{% endhighlight %}

For more about the possible configuration options, see the
[configuration](../configuration/) page.
[configuration](../configuration/) page.