update documentation of how to run the code #554
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
quozl
requested changes
Nov 16, 2024
| @@ -82,11 +82,13 @@ cd www | |||
| ### Installation | |||
| Install Ruby and the Gem package manager (pre-installed in Mac OS X) and install `jekyll` and its related packages available in the Github hosted version by running, from this directory: | |||
|
|
|||
| bundle install; | |||
| bundle install | |||
| ### Running | ||
| Jekyll can run a local web server that rebuilds each time you save a page while editing (Execute the below command from root directory): | ||
|
|
||
| bundle exec jekyll serve --incremental; | ||
| `jekyll serve`: rebuilds the entire website from scratch each time. |
There was a problem hiding this comment.
Missing bundle exec.
Narrative is up against the command. Please break the line, as is the style now in use.
| bundle exec jekyll serve --incremental; | ||
| `jekyll serve`: rebuilds the entire website from scratch each time. | ||
|
|
||
| `bundle exec jekyll serve --incremental`:Only regenerates changed files since the last build, making development faster and more efficient but does not render posts (i.e. FAQ, blog, news, and events). |
There was a problem hiding this comment.
Narrative is up against the command. Please break the line, as is the style now in use.
Your commit message could be simpler; e.g. Add Jekyll incremental vs full serve running docs.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
@pikurasa Can you please review it.