Skip to content

oyoboyo/columnist

Repository files navigation

Columnist

A feature rich blog starter for Next.js, built with savvy creators in mind.

Getting started

Built for Next.js Columnist is open source and extensible, but easy enough for savvy web creators. Getting started is simple.

Setup

In your terminal, create a Next.js app with the Columnist starter:

npx create-next-app --example https://github.com/oyoboyo/columnist/tree/workspace/starters/free

Run the project locally:

npm run dev

Then visit http://localhost:3000/ in your browser to view, and develop your site locally.

Create

Using your integrated development environment or text editor of choice:

  1. Add Markdown files to the content folder e.g., content/about.md
  2. Organize content collections in folders e.g., content/articles
  3. Nest folders to build content structure e.g., content/issues/[issue]/[article]
  4. See content on your site, at a route matching the folder structure e.g., /about or /articles

Customize

Columnist can be configured in a number of ways, for example:

  1. Configure the site by editing values under .config
  2. Site logo at public/graphics/logo.svg
  3. Edit colour and other style variables at src/style/custom.scss

Deploy

Deployment of your site is pretty easy:

  1. Start with a new git repository in your Columnist site folder
  2. Create content, configure, and customize, then git commit your site to Github
  3. Deploy your site to Vercel by importing your git repository