isabella232 / blog-5

The video.js blog

video.js blog

The new video.js blog based on hexo and deployed using netlify.

Lead Maintainer: Gary Katsevman @gkatsev

Maintenance Status: Stable

Table of Contents

• New Posts
  • Step 1: Writing the post and opening a PR
  • Step 2: When you are done writing
• Running the blog locally
• Editing Published posts
• Running other hexo commands

New Posts

Step 1: Writing the post and opening a PR

To write a new post on the blog. Create a new fork/branch of videojs/blog repo and then run:

npm run draft -- "blog title"

Note: At any point after this you can start a server that will show drafts by running npm start

This will create a folder and a markdown file. In the example they would be:

source/_drafts/blog-title/
source/_drafts/blog-title.md

Your actual blog post is the markdown file and the folder is where you can store any assets for that post. For instance to add an image videojs.png to our example blog post you would add the image file to source/_drafts/blog-title/videojs.png. Then you can reference that image using markdown syntax in source/_drafts/blog-title.md as ![videojs image](videojs.png).

Don't forget to fill out the yaml front-matter at the top of your blog post. Especially the author name and github username. These will allow the post to display your information as the author of the blog post.

author:
  name: Your Name
  github: githubusername

Step 2: When you are done writing

Open a pull request against the master branch of videojs/blog

Then get a review and approval from someone in the Video.js organization.

Note: Your PR will have a netlify preview built for it so that you can preview your draft. Check out the status checks in your PR.

After your post is approved, you have to publish your post. In hexo this means moving your markdown file and folder into a folder in _posts. To do that you run:

npm run publish -- "blog title"

This will also update the timestamp and other metadata. Be sure to verify that your yaml front-matter is still correct (such as your author name, and github username).

To visually verify how your blog post looks at this point you can:

1. Push your changes up to your fork/branch and wait for netlify to generate another preview
2. Run a local dev server with npm start.

Your post will be released by netlify as soon as it is merged into master!

Running the blog locally

To see your drafts and create a local server that watches your changes, just run

npm start

Editing Published posts

Published posts are located in source/_posts with their post name as the blog title. Feel free to make an edit in a fork/branch and open a pull request against the master branch of videojs/blog.

Running other hexo commands

You can run other hexo commands with the local npm binary or by using the the hexo npm script:

npm run hexo -- help

Make sure that the -- is there and is separate from the rest of the commands.