bencodezen / vuepress-blog-boilerplate

An ever-evolving and opinionated dev environment for people who want to use VuePress to power their blogs.

VuePress Blog Boilerplate (Deprecated)

This is a deprecated opinionated architecture that uses VuePress v1.0.0-alpha to power a blogging platform.

Purpose

To provide a blueprint of how blogging is possible with VuePress v1.0.0-alpha and empower you with enough boilerplate so you feel comfortable customizing it to your liking.

Why is it deprecated?

As my work with OSS expands, I wanted the flexibility to switch tech stacks as the requirements for my own blog / site requirements increase. As a result, I do not have the time to maintain this one since it would be a separate effort from my current OSS work.

To follow the latest, you can follow the new repo at Ben's Blog Boilerplate.

Features

• Write posts in Markdown
• Basic pagination sorted by most recent posts
• Ability to search for posts via headings within the post
• Archived posts page
• Basic scheduling for future publishing
• Basic tagging for posts
• Automatic RSS feed generation
• Easily integrate Google Analytics

Getting Started

Prerequisites

• NodeJS 12
• yarn (Recommended)
• Basic knowledge of navigating the terminal

Installation

If your plan is follow the tutorial all the way through to deployment, make sure you fork this project instead of simply cloning it!

In your terminal, navigate to the desired directory where you want this project to live.

# Clone the repo for local development
git clone https://github.com/bencodezen/vuepress-blog-boilerplate.git

# Change directory into project
cd vuepress-blog-boilerplate

# Install dependencies
yarn

# Run local server
yarn dev

You should now be able to visit http://localhost:8080!

Documentation

To check out the tutorial and docs, check out the guide.

Examples

• VuePress Blog Boilerplate Demo
• BenCodeZen Blog

Hat Tip

For those familiar with the Vue.js ecosystem, you might be reminded of Chris Fritz's Vue Enterprise Boilerplate and you would be absolutely right. I thought the concept was brilliant and wanted to do something similar for the VuePress ecosystem since blogging is something that still requires a fair amount of configuration and knowledge in order to get started.

And in case you didn't know, Chris Fritz is one of the core contributors to the incredible Vue.js docs that we all love so much. So if you would like to help support him so he can spend more time on creating awesome content for the Vue.js community, please support him by becoming a sponsor on Patreon.