Skip to content

Commit 8422e26

Browse files
committed
Add 'bundle exec jekyll serve' instruction to README.md
1 parent a83c900 commit 8422e26

File tree

2 files changed

+6
-4
lines changed

2 files changed

+6
-4
lines changed

Gemfile

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,3 +6,5 @@ source "https://rubygems.org"
66
git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
77

88
gem 'github-pages', group: :jekyll_plugins
9+
10+
gem 'wdm', '>= 0.1.0' if Gem.win_platform?

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -57,15 +57,15 @@ Open a command line in the root directory of the repository.
5757

5858
If this is the first time you have built the site, make sure you have run `bundle pack` before attempting to build the site using jekyll.
5959

60-
Otherwise, run `bundle exec jekyll build` to build the site, this will produce a `_site` folder with the required content.
60+
Next, run `bundle exec jekyll build` to build the site. This will produce a `_site` folder with the required content.
6161

6262
>:Warning: do not edit anything in the site folder as it will not be comitted and is overwritten everytime you build the site.
6363
64-
To rebuild the site after a file change append `--watch` to the end of the command.
64+
Once you have a `_site` folder, open the `index.html` file inside to view the site.
6565

66-
e.g. `bundle exec jekyll build --watch`
66+
You will normally need to rebuild the site every time you save a change to a file. To rebuild the site automatically after each update append `--watch` to the end of the command, i.e. `bundle exec jekyll build --watch`
6767

68-
Once you have a `_site` folder open the `index.html` file inside to view the site.
68+
>:Warning: The website uses extensionless links, meaning we don't need to include the '.html' extension on web pages and in anchor (<a>) links. In order that these links work while you view the site locally, open a new command-line window, navigate to the folder containing the website's source code, and run `bundle exec jekyll serve`. Leave that window running while you make your changes.
6969
7070
## Includes
7171

0 commit comments

Comments
 (0)