Skip to content

Commit b9f9ee0

Browse files
committed
📝 Minor edits; don't affect functionality.
1 parent e1f3f1f commit b9f9ee0

File tree

4 files changed

+37
-27
lines changed

4 files changed

+37
-27
lines changed

CHANGELOG.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,16 @@
33
Below is a detailed change-log, along with specific tasks completed, for each
44
version released to date for the Jekyll Heroku Starter Kit.
55

6+
## Version 1.0.1 (26/05/2018)
7+
8+
Minor edits; don't affect functionality.
9+
10+
- [#new](#new)
11+
- New settings added to VS Code Workspace file.
12+
- [#bugfix](#bugfix)
13+
- Fixed broken link in `README.md`.
14+
- Removed unnecessary whitespace in `README.md` and `index.md`.
15+
616
## Version 1.0.0 (26/05/2018)
717

818
First _production-ready_ release. Works out the box.
@@ -27,4 +37,3 @@ First _production-ready_ release. Works out the box.
2737

2838
- [#new](#new)
2939
- Initial Commit
30-
- [#bugfix](#bugfix)

README.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ for ease of use along with a default, minimal theme.
3636
- All required files to run a Jekyll site in minutes on Heroku.
3737
- [jekyll-theme-minimal][jekyll-theme-minimal] - Default minimal theme installed.
3838
- `static.json` - used by the Heroku static buildpack.
39-
- `Rakefile` - the Heroku Ruby buildpack runs rake assets:precompile
39+
- `Rakefile` - the Heroku Ruby buildpack runs `rake assets:precompile`
4040
when it’s available.
4141
- `config.ru` - the config file that enables this gem to serve your app on
4242
Heroku using [RackJekyll][rack].
@@ -48,11 +48,11 @@ These plugins are installed by default:
4848
- [jemoji][jemoji]
4949
- [jekyll-mentions][jekyll-mentions]
5050
- [jekyll-feed][jekyll-feed]
51-
- Generates an XML Feed at `http://yourdomain.com/feed.xml`
51+
- Generates an XML Feed at `http://yourdomain.com/feed.xml`
5252
- [jekyll-seo-tag][jekyll-seo-tag]
53-
- [jekyll-sitemap][jekyll-sitemap]
54-
- Generates a XML Sitemap at `http://yourdomain.com/sitemap.xml`
55-
- Generates a `robots.txt` file at `http://yourdomain.com/robots.txt`
53+
- [jekyll-sitemap][jekyll-sitemap]
54+
- Generates a XML Sitemap at `http://yourdomain.com/sitemap.xml`
55+
- Generates a `robots.txt` file at `http://yourdomain.com/robots.txt`
5656
- [jekyll-paginate-v2][jekyll-paginate-v2]
5757
- [jekyll-include-cache][jekyll-include-cache]
5858
- [jekyll-last-modified-at][jekyll-last-modified-at]
@@ -74,9 +74,9 @@ work.
7474

7575
1. [Heroku Toolbelt][toolbelt] - the CLI interface to Heroku.
7676
1. A package manager for your Operating System:
77-
- macOS: [Homebrew][brew]
78-
- Windows: [Chocolatey][choc]
79-
- Linux: `apt-get` or `yum` (distro dependent)
77+
- macOS: [Homebrew][brew]
78+
- Windows: [Chocolatey][choc]
79+
- Linux: `apt-get` or `yum` (distro dependent)
8080
1. [Ruby][ruby]
8181
1. [Bundler][bundler] - to manage Ruby gems (see below).
8282

@@ -92,7 +92,7 @@ $ gem install bundler
9292
### 3.1. Clone the Repository
9393

9494
The first step is to clone this repository to a location on your computer. For
95-
this example we will assume that your default install location is a folder
95+
this example we will assume that your default install location is a folder
9696
called `jekyll-heroku-starter-kit`.
9797

9898
```terminal
@@ -133,7 +133,7 @@ remote.origin.fetch=+refs/heads/*:refs/remotes/origin/*
133133
### 3.3. Install required Gems
134134

135135
The `Gemfile` in this repository contains everything needed to setup Jekyll and
136-
get your app ready for publishing to Heroku. Run the following command to
136+
get your app ready for publishing to Heroku. Run the following command to
137137
install all the required dependencies.
138138

139139
```terminal
@@ -152,9 +152,9 @@ $ heroku buildpacks:add https://github.com/heroku/heroku-buildpack-static
152152

153153
### 3.5. Running Jekyll Locally
154154

155-
Once done with the above you should test your Jekyll installation to ensure
155+
Once done with the above you should test your Jekyll installation to ensure
156156
that you are able to run the site on your machine. This is very important
157-
before deploying your app to Heroku.
157+
before deploying your app to Heroku.
158158

159159
Run the `jekyll serve` command to test your app.
160160

@@ -177,7 +177,7 @@ Invalid theme folder: _includes
177177
By visiting [http://127.0.0.1:4000][localhost] you should see your newly
178178
built Jekyll site. This is an example of what you should be seeing.
179179

180-
![][livesite]
180+
![Jekyll Site][livesite]
181181

182182
## 4. Deployment
183183

@@ -351,7 +351,7 @@ some way to make this project a reality.
351351
- [Andy Croll][andy] - for his post on serving a Jekyll site on Heroku.
352352
- [Heroku][heroku] - for their post on running Jekyll on their platform.
353353

354-
[deploy]: #deployment
354+
[deploy]: #4-deployment
355355
[CONTRIBUTING]: CONTRIBUTING.md
356356
[COC]: CODE_OF_CONDUCT.md
357357
[license]: LICENSE

index.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ for ease of use along with a default, minimal theme.
1313
- All required files to run a Jekyll site in minutes on Heroku.
1414
- [jekyll-theme-minimal][jekyll-theme-minimal] - Default minimal theme installed.
1515
- `static.json` - used by the Heroku static buildpack.
16-
- `Rakefile` - the Heroku Ruby buildpack runs rake assets:precompile
16+
- `Rakefile` - the Heroku Ruby buildpack runs `rake assets:precompile`
1717
when it’s available.
1818
- `config.ru` - the config file that enables this gem to serve your app on
1919
Heroku using [RackJekyll][rack].
@@ -25,11 +25,11 @@ These plugins are installed by default:
2525
- [jemoji][jemoji]
2626
- [jekyll-mentions][jekyll-mentions]
2727
- [jekyll-feed][jekyll-feed]
28-
- Generates an XML Feed at `http://yourdomain.com/feed.xml`
28+
- Generates an XML Feed at `http://yourdomain.com/feed.xml`
2929
- [jekyll-seo-tag][jekyll-seo-tag]
30-
- [jekyll-sitemap][jekyll-sitemap]
31-
- Generates a XML Sitemap at `http://yourdomain.com/sitemap.xml`
32-
- Generates a `robots.txt` file at `http://yourdomain.com/robots.txt`
30+
- [jekyll-sitemap][jekyll-sitemap]
31+
- Generates a XML Sitemap at `http://yourdomain.com/sitemap.xml`
32+
- Generates a `robots.txt` file at `http://yourdomain.com/robots.txt`
3333
- [jekyll-paginate-v2][jekyll-paginate-v2]
3434
- [jekyll-include-cache][jekyll-include-cache]
3535
- [jekyll-last-modified-at][jekyll-last-modified-at]
@@ -69,7 +69,7 @@ $ gem install bundler
6969
### Clone the Repository
7070

7171
The first step is to clone this repository to a location on your computer. For
72-
this example we will assume that your default install location is a folder
72+
this example we will assume that your default install location is a folder
7373
called `jekyll-heroku-starter-kit`.
7474

7575
```terminal
@@ -110,7 +110,7 @@ remote.origin.fetch=+refs/heads/*:refs/remotes/origin/*
110110
### Install required Gems
111111

112112
The `Gemfile` in this repository contains everything needed to setup Jekyll and
113-
get your app ready for publishing to Heroku. Run the following command to
113+
get your app ready for publishing to Heroku. Run the following command to
114114
install all the required dependencies.
115115

116116
```terminal
@@ -129,9 +129,9 @@ $ heroku buildpacks:add https://github.com/heroku/heroku-buildpack-static
129129

130130
### Running Jekyll Locally
131131

132-
Once done with the above you should test your Jekyll installation to ensure
132+
Once done with the above you should test your Jekyll installation to ensure
133133
that you are able to run the site on your machine. This is very important
134-
before deploying your app to Heroku.
134+
before deploying your app to Heroku.
135135

136136
Run the `jekyll serve` command to test your app.
137137

@@ -154,7 +154,7 @@ Invalid theme folder: _includes
154154
By visiting [http://127.0.0.1:4000][localhost] you should see your newly
155155
built Jekyll site. This is an example of what you should be seeing.
156156

157-
![][livesite]
157+
![Jekyll Site][livesite]
158158

159159
## Deployment
160160

@@ -328,7 +328,7 @@ some way to make this project a reality.
328328
- [Andy Croll][andy] - for his post on serving a Jekyll site on Heroku.
329329
- [Heroku][heroku] - for their post on running Jekyll on their platform.
330330

331-
[deploy]: #deployment
331+
[deploy]: #4-deployment
332332
[CONTRIBUTING]: CONTRIBUTING.md
333333
[COC]: CODE_OF_CONDUCT.md
334334
[license]: LICENSE

starter-kit.code-workspace

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,8 @@
2020
"editor.trimAutoWhitespace": false,
2121
},
2222
"markdownlint.config": {
23-
"MD001": false
23+
"MD001": false,
24+
"MD014": false
2425
},
2526
}
2627
}

0 commit comments

Comments
 (0)