/node-blog-starter

📖 A simple, fast, bloat-free Markdown blog template powered by Node.js.

Primary LanguageJavaScript

node-blog-starter

A barebones, no-bloat starter blog in Node, using Markdown to format posts, and Handlebars to server-side render. Posts are created and accessed through the /posts folder in Markdown format.

The blog has 2 simple endpoints with accompanying views:

  • /

    • Home view, for displaying your blog posts to viewers.
  • /post/<POST>

    • Post view, for displaying a Markdown post to viewers.

Setup

yarn install

Usage

Development

Run the blog using Nodemon and livereload.js for development.

yarn dev

Build

Build the blog into a static directory using wget magic.

yarn build

Github Actions

On push to master Github Actions will trigger a deploy to your gh-pages for this repository. This means that the blog may be managed entirely through Github's Markdown editor if desired, simply adding new blog posts in the posts/ directory, which triggers the Github Action CI flow to build static content and deploy to gh-pages.