# @columnist/core

> A feature rich and familiar blog starter for Next.js built with writers (and their readers) in mind. Self-publish (and own your platform).

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

## Install

```sh
npm install @columnist/core
pnpm add @columnist/core
yarn add @columnist/core
bun add @columnist/core
```

## Health

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

Positive: has types; no vulnerabilities.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.2.12 |
| Published | 2022-11-08 |
| First published | 2022-01-16 |
| Weekly downloads | 0 |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 17 |
| Unpacked size | 22 KB |
| Known vulnerabilities | 0 (+16 in 1 direct dependencies) |
| Install scripts | no |
| Maintainers | seanrioux |

## Links

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

## Dependencies (17)

- [next](https://npm.io/package/next.md) ^12.1.0
- [react](https://npm.io/package/react.md) ^17.0.2
- [remark](https://npm.io/package/remark.md) ^13.0.0
- [slugify](https://npm.io/package/slugify.md) ^1.6.1
- [unified](https://npm.io/package/unified.md) ^9.2.0
- [react-dom](https://npm.io/package/react-dom.md) ^17.0.2
- [@root/walk](https://npm.io/package/@root/walk.md) ^1.1.0
- [rehype-raw](https://npm.io/package/rehype-raw.md) ^6.1.0
- [title-case](https://npm.io/package/title-case.md) ^3.0.3
- [gray-matter](https://npm.io/package/gray-matter.md) ^4.0.3
- [remark-html](https://npm.io/package/remark-html.md) ^13.0.2
- [remark-parse](https://npm.io/package/remark-parse.md) ^8.0.3
- [remark-react](https://npm.io/package/remark-react.md) ^8.0.0
- [remark-rehype](https://npm.io/package/remark-rehype.md) ^10.0.1
- [strip-markdown](https://npm.io/package/strip-markdown.md) ^5.0.0
- [rehype-truncate](https://npm.io/package/rehype-truncate.md) ^1.2.2
- [rehype-stringify](https://npm.io/package/rehype-stringify.md) ^9.0.2

## Recent versions

- 0.2.12 (latest) — 2022-11-08
- 0.2.11 — 2022-04-14
- 0.2.10 — 2022-04-11
- 0.2.9 — 2022-04-06
- 0.2.8 — 2022-03-19
- 0.2.7 — 2022-03-18
- 0.2.6 — 2022-03-18
- 0.2.5 — 2022-03-14
- 0.2.4 — 2022-03-14
- 0.2.3 — 2022-03-10
- 0.2.2 — 2022-03-10
- 0.2.1 — 2022-03-09
- 0.2.0 — 2022-03-01
- 0.1.4 — 2022-01-22
- 0.1.3 — 2022-01-20
- … 3 more at https://npm.io/package/@columnist/core/versions

## README

# Columnist

A feature rich and familiar blog starter for Next.js built with writers (and their readers) in mind. Self-publish (and own your platform).

## **Features**

Columnist lets you:

- Create articles and pages with Markdown
- Manage content collections to build structure
- Easily configure, customize, and deploy you site
- Extend with [Next.js](https://nextjs.org/)
-

# Documentation

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

# Getting started

Getting started is simple (assuming you’re setup with [Node.js](https://www.newline.co/@Adele/how-to-install-nodejs-and-npm-on-macos--22782681)):

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

Columnist makes it easy to add and organize content to your site with [Markdown](https://www.markdownguide.org/cheat-sheet/).

Using your [integrated development environment](https://code.visualstudio.com/) or text editor of choice:

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

Columnist has been designed to be intuitive for creators really — just add Markdown.

# Configure

Columnist can be configured in a number of ways, for example, to customize brand, the header, or footer.

- For all configuration options [read our guide for creators](https://www.notion.so/For-creators-b2dafe28cee74b7aaa4d1fe97eb8c0df)
- To edit configuration, it’s file `columnist.config.js` in the root folder

# Customize

Columnist can also be customized to accommodate your brand:

## Logo

The site logo can also be replaced at `public/graphics/logo.svg`.

- The default logo is a `500 x 500 px` square icon `*.svg` file

## Icons

Favicon have been included for a range of devices:

- The starter favicons can be changed by replacing the files under `public/favicon`
- To generate favicons we recommend [https://realfavicongenerator.net/](https://realfavicongenerator.net/)

## Style

Columnist uses SCSS and Bootstrap for style ([React Bootstrap optional](https://react-bootstrap.github.io/)). To customize:

- Edit or add default Bootstrap variables to `src/style/custom.scss`
- Add additional SCSS files (and import them to `src/style/index.scss`)

**Note:** Read [Bootstrap documentation](https://getbootstrap.com/docs/4.0/getting-started/theming/) for more information on customizing Bootstrap.

# 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

Vercel is [free for non-commericial hosting](https://vercel.com/pricing) for when your just getting started.

👉 **Note:** new to git? No problem. [Learn the basics.](https://rogerdudler.github.io/git-guide/)

# Develop

Columnist was built with Next.js so all the Next.js [documentation](https://nextjs.org/docs/getting-started) will apply.

We’ve also built in some useful core concepts for development of content centric websites:

- [Themes](https://www.notion.so/For-developers-3b5f7eb718a743c9a15b97762b1f114d), allowing you to customize content components
- [Services](https://www.notion.so/For-developers-3b5f7eb718a743c9a15b97762b1f114d), that help you get `content` when you build Next.js pages
- [Utilities](https://www.notion.so/For-developers-3b5f7eb718a743c9a15b97762b1f114d), [starters](https://www.notion.so/For-developers-3b5f7eb718a743c9a15b97762b1f114d), a [monorepo](https://www.notion.so/For-developers-3b5f7eb718a743c9a15b97762b1f114d)... lots to help you expand on simple columns

👉 **Note:** new to Next.js? No problem. [Learn the basics.](https://nextjs.org/learn/foundations/about-nextjs?utm_source=next-site&utm_medium=nav-cta&utm_campaign=next-website)

# Contribute

We’re just ramping up, but we will take contributors. To get in touch to contribute talk to [Sean Rioux on Github](https://github.com/oyoboyo/columnist/discussions).

— however if you want to poke around at the monorepo, feel free. [Documentation here](https://www.notion.so/For-contributors-f63563f256a94f44bcda6d234ce8de38).

# Appendix

[Outline](https://www.notion.so/Outline-1fb14499acb84c61ba3f1c08a45cdf3f)

## Changelog

### v0.1.0

- Initialize Columnist Monorepo, core, themes, starter
- **Stories:** create content, customize, configure, deploy

### v0.2.0

- Services refactoring

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