Snapshot of jekyll/jekyll-compose: 733★, Ruby. :memo: Streamline your writing in Jekyll with these commands.
Snapshot summary built from the project's own GitHub metadata — there's no written TopGit review yet. The page will update automatically when a full review is published.
WHY NO REVIEW YET
TopGit writes full reviews for the most-starred, most-requested repositories. This page is a snapshot until then — see the READ ME tab for the original README in full.
Streamline your writing in Jekyll with some commands.
Installation
Add this line to your application's Gemfile:
gem 'jekyll-compose', group: [:jekyll_plugins]
And then execute:
$ bundle
Usage
After you have installed (see above), run bundle exec jekyll help and you should see:
Listed in help you will see new commands available to you:
draft # Creates a new draft post with the given NAME
post # Creates a new post with the given NAME
publish # Moves a draft into the _posts directory and sets the date
unpublish # Moves a post back into the _drafts directory
page # Creates a new page with the given NAME
rename # Moves a draft to a given NAME and sets the title
compose # Creates a new file with the given NAME
Create your new page using:
$ bundle exec jekyll page "My New Page"
Create your new post using:
$ bundle exec jekyll post "My New Post"
# or specify a custom format for the date attribute in the yaml front matter
$ bundle exec jekyll post "My New Post" --timestamp-format "%Y-%m-%d %H:%M:%S %z"
# or by using the compose command
$ bundle exec jekyll compose "My New Post"
# or by using the compose command with post specified
$ bundle exec jekyll compose "My New Post" --post
# or by using the compose command with the posts collection specified
$ bundle exec jekyll compose "My New Post" --collection "posts"
Create your new draft using:
$ bundle exec jekyll draft "My new draft"
# or by using the compose command with draft specified
$ bundle exec jekyll compose "My new draft" --draft
# or by using the compose command with the drafts collection specified
$ bundle exec jekyll compose "My new draft" --collection "drafts"
Rename your draft using:
$ bundle exec jekyll rename _drafts/my-new-draft.md "My Renamed Draft"
# or rename it back
$ bundle exec jekyll rename _drafts/my-renamed-draft.md "My new draft"
# or specify a specific date on which to publish it
$ bundle exec jekyll publish _drafts/my-new-draft.md --date 2014-01-24
# or specify a custom format for the date attribute in the yaml front matter
$ bundle exec jekyll publish _drafts/my-new-draft.md --timestamp-format "%Y-%m-%d %H:%M:%S %z"
Rename your post using:
$ bundle exec jekyll rename _posts/2014-01-24-my-new-draft.md "My New Post"
# or specify a specific date
$ bundle exec jekyll rename _posts/2014-01-24-my-new-post.md "My Old Post" --date "2012-03-04"
# or specify the current date
$ bundle exec jekyll rename _posts/2012-03-04-my-old-post.md "My New Post" --now
$ bundle exec jekyll compose "My New Thing" --collection "things"
Configuration
To customize the default plugin configuration edit the jekyll_compose section within your jekyll config file.
auto-open new drafts or posts in your editor
jekyll_compose:
auto_open: true
and make sure that you have EDITOR, VISUAL or JEKYLL_EDITOR environment variable set.
For instance if you wish to open newly created Jekyll posts and drafts in Atom editor you can add the following line in your shell configuration:
export JEKYLL_EDITOR=atom
JEKYLL_EDITOR will override default EDITOR or VISUAL value.
VISUAL will override default EDITOR value.
Set default front matter for drafts and posts
If you wish to add default front matter to newly created posts or drafts, you can specify as many as you want under default_front_matter config keys, for instance:
For collections, you can add default front matter to newly created collection files using default_front_matter and the collection name as a config key, for instance for the collection things:
Fork it ( http://github.com/jekyll/jekyll-compose/fork )
Create your feature branch (git checkout -b my-new-feature)
Run the specs and our linter (script/cibuild)
Commit your changes (git commit -am 'Add some feature')
Push to the branch (git push origin my-new-feature)
Create new Pull Request
Submitting a Pull Request based on an existing proposal
When submitting a pull request that uses code from an unmerged pull request, please be aware of the following:
Changes proposed in the older pull request is still the original author's property. Moving forward from where they left it
means that you're a co-author.
GitHub allows attributing
credit to multiple authors
However, pull requests in this project are automatically squashed and then merged onto the base branch. So, only authors and
co-authors of the opening commit gets credit once the pull request gets merged.
If the original pull request contained multiple commits, you may squash them into a single commit but ensure that you list
any additional authors (and yourselves) as co-authors of that commit.
Use appropriate keywords in your pull request post to
link to the existing pull request or issue-ticket so that they're automatically closed when your pull request gets merged.
How active is development on jekyll/jekyll-compose?
The most recent commit recorded on jekyll/jekyll-compose was 3.6 years ago, based on the GitHub push timestamp. The repository has 81 forks — one of the better signals of community interest.
How many stars does jekyll/jekyll-compose have?
jekyll/jekyll-compose has 733 GitHub stars — refresh the page for the live number, or check github.com/jekyll/jekyll-compose. TopGit mirrors GitHub's count but does not claim minute-by-minute accuracy.
Is jekyll/jekyll-compose open source?
Yes — jekyll/jekyll-compose ships under the MIT license, which makes its source code freely readable (and, depending on license terms, forkable and reusable). Source: github.com/jekyll/jekyll-compose.
What is jekyll/jekyll-compose?
jekyll/jekyll-compose (jekyll/jekyll-compose) is a Ruby project on GitHub. From the project's own README: :memo: Streamline your writing in Jekyll with these commands.
Where do I read more about jekyll/jekyll-compose?
This TopGit page is a snapshot — the READ ME tab shows the project's own README content (links stripped, images preserved). The GitHub repository at github.com/jekyll/jekyll-compose is the definitive source.
Read full README in the tab above.
Curious whether jekyll-compose is right for you?
Let ChatGPT, Claude, or Perplexity look into it — click below and see what AI actually says about jekyll-compose.