# columnist-free

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

Latest version **0.2.2** (published 2022-11-08) · 0 weekly downloads

## Install

```sh
npm install columnist-free
pnpm add columnist-free
yarn add columnist-free
bun add columnist-free
```

## Health

**Score 10/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; low quality score; large bundle; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.2.2 |
| Published | 2022-11-08 |
| First published | 2022-11-08 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 14 |
| Unpacked size | 16.7 MB |
| Known vulnerabilities | 0 (+16 in 2 direct dependencies) |
| Install scripts | no |
| Maintainers | seanrioux |

## Links

- npm: https://www.npmjs.com/package/columnist-free
- npm.io page: https://npm.io/package/columnist-free

## Dependencies (14)

- [next](https://npm.io/package/next.md) ^12.1.0
- [sass](https://npm.io/package/sass.md) ^1.32.7
- [voca](https://npm.io/package/voca.md) ^1.4.0
- [react](https://npm.io/package/react.md) ^17.0.2
- [firebase](https://npm.io/package/firebase.md) ^9.8.2
- [bootstrap](https://npm.io/package/bootstrap.md) ^5.1.1
- [react-dom](https://npm.io/package/react-dom.md) ^17.0.2
- [react-icons](https://npm.io/package/react-icons.md) ^4.2.0
- [next-sitemap](https://npm.io/package/next-sitemap.md) ^1.6.18
- [@columnist/core](https://npm.io/package/@columnist/core.md) ^0.2.0
- [react-bootstrap](https://npm.io/package/react-bootstrap.md) ^2.5.0
- [next-remote-watch](https://npm.io/package/next-remote-watch.md) ^1.0.0
- [react-firebase-hooks](https://npm.io/package/react-firebase-hooks.md) ^5.0.3
- [next-transpile-modules](https://npm.io/package/next-transpile-modules.md) ^9.0.0

## Recent versions

- 0.2.2 (latest) — 2022-11-08

## README

# Columnist

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

## Documentation

- [For creators](https://www.notion.so/For-creators-b2dafe28cee74b7aaa4d1fe97eb8c0df)
- [For developers](https://www.notion.so/For-developers-3b5f7eb718a743c9a15b97762b1f114d)

# Getting started

Built for [Next.js](https://nextjs.org/) 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:

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

Run the project locally:

```yaml
npm run dev
```

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

## Create

Using your [integrated development environment](https://code.visualstudio.com/) 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. Brand and configuration `columnist.config.js` in the root folder
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](https://kbroman.org/github_tutorial/pages/init.html) in your Columnist site folder
2. Create content, configure, and customize, then git commit your site to Github
3. [Deploy your site to Vercel](https://vercel.com/guides/deploying-react-with-vercel) by importing your git repository

---
_Source: https://npm.io/package/columnist-free · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
