Skip to content

Commit 317b728

Browse files
committed
Updating the readme to provide assistance for the "I can't see jekyll compose commands" issue (#4).
Also adding a basic usage example to make clear the commands available. I initially expected I would run `jekyll compose draft "My New Draft"`
1 parent 44a5070 commit 317b728

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

README.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,28 @@ Or install it yourself as:
2222

2323
Install `jekyll-compose` and run `jekyll help`.
2424

25+
Listed in help you will see new commands available to you:
26+
27+
```sh
28+
draft Creates a new draft post with the given NAME
29+
post Creates a new post with the given NAME
30+
publish Moves a draft into the _posts directory and sets the date
31+
```
32+
33+
Create your new post using:
34+
35+
$ jekyll post "My New Post"
36+
37+
## Helpful Note
38+
39+
If after installing the jekyll-compose gem you still do not see the above commands avaiable to you, try including the gem in the jekyll_plugins group of your Gemfile like so:
40+
41+
```ruby
42+
group :jekyll_plugins do
43+
gem 'jekyll-compose'
44+
end
45+
```
46+
2547
## Contributing
2648

2749
1. Fork it ( http://github.com/<my-github-username>/jekyll-compose/fork )

0 commit comments

Comments
 (0)