newpost

newpost: make GitHub Pages/Jekyll blog posts, faster.

A little utility that creates a blog post file quickly, without copying and pasting front matter. Hate trying to remember what kind of front matter to put in your posts? Can't remember what ISO 8601 date format is to save your life? Install newpost and make managing your Jekyll/GitHub Pages blog posts easier than ever.

How does it work? 👀

Glad you asked! newpost adds in a custom config object to your package.json that contains front matter for your site. Running newpost init after installing lets you configure your front matter any way you like, and you configure it on a per project basis, so all your sites can have different blog post metadata.

newpost can also take front matter prop:value pairs straight from the command line! You can override properties from your config, as well as adding in any other property you want to have in your front matter for that post.

How to use newpost

Installation 🚀

npm:

npm install newpost

Yarn:

yarn add newpost

Set up front matter 💻 (Optional)

newpost init

Then start adding your metadata. Use this format <property>:<value> when adding front matter, and type q and hit enter when you're done!

Start blogging 🎉📝

You're all set up! If you set up a config object, you can run newpost myNewPostName to create a new blog entry with your default front matter. title is set to myNewPostName by default. The output looks like this:

---
title: myNewPostName
# everything else defined in your config object goes here... 
---
 

To override that or any config-defined property, just pass it in as an arg:

newpost myNewPostName --title MyTitle --author Jahziel --coolProp awesome

This will create a new blog post file called <current ISO 8601 date>.myNewPostName.md, with the following contents:

---
title: myTitle
author: Jahziel
coolProp: awesome
# everything else defined in your config object goes here... 
---
 

Make sure you pass in values with spaces in quotes!

newpost myNewPost --title "My really long blog post title" --author Jahziel --coolProp awesome

will give you:

---
title: My really long blog post title
author: Jahziel
coolProp: awesome
# everything else defined in your config object goes here... 
---
 

--draft

Adding the --draft flag to any of the above commands will create a draft file instead of a post file. This means that the file will be created in the /_drafts directory instead of the /_posts directory. Additionally, the file will be called post_name.md instead of today-in-ISO8601-post_name.md. Files in the /drafts folder are ignored by Jekyll/GitHub Pages, so you can commit them, but they won't be public. Once you're done crafting the Next Great Blog Entry™️, use the undraft command to move your draft to the big leagues (/posts)!

Other commands 🖍

• --help shows a help message with a quick breakdown of what newpost does!
• --version shows the currently installed version
• undraft post_name moves the post with filename post_name.md to the /_posts directory. If you don't have a /_posts, it creates it for you.
• clean removes any config data that has been written to package.json

Dev stuff 👨‍💻👩‍💻

Getting started 🛫

Clone this repo! Then

yarn install

or

npm install

Testing 🧪

There are tests! You can run them! Just run

yarn test

or

npm test

You can open up /coverage/index.html to get a detailed coverage report.