Skip to content
forked from timlrx/pliny

Create content rich websites with ease - built on next.js, contentlayer and tailwindcss

License

Notifications You must be signed in to change notification settings

bravo-kernel/pliny

 
 

Repository files navigation

Pliny

Note: Pliny is currently in alpha. Expect breaking changes.

Pliny makes creating, editing and publishing markdown content easy and simple. It is based on Next.js, Tailwind CSS and Contentlayer.

Installation

npm i -g @pliny/cli

Usage

Here are some examples of common commands:

Create a new starter blog project called "my-blog"

pliny new --template=starter-blog my-blog

Add a recipe

Currently, there are 2 main types of recipes - scaffolding a content type e.g. the pages associated with a blog or adding templates to the layouts folder. As a convention, recipes to scaffold are in the form of add-[content type] while layouts are in the form of [content type]-[theme].

Adding a blog page to an existing Next.js application (assumes you have contentlayer setup, as it will automatically add defineDocumentType)

pliny install add-blog ContentDir=data ContentName=Blog

Add the blog-classic templates to the layouts folder:

pliny install blog-classic

Features

Content Modeling with Contentlayer

  • Live reload on content changes
  • Fast and incremental builds
  • Simple but powerful schema DSL to design your content model (validates your content and generates types)
  • Auto-generated TypeScript types based on your content model (e.g. frontmatter or CMS schema)

Templates

  • Based on Next.js and Tailwindcss
  • Highly configurable config, easily extendable nextjs website
  • Mobile friendly
  • Supports light and dark theme
  • Layouts to customize templates
  • Blog theme is completed, docs is in the works

Full suite of markdown plugins

Modular React components for services

  • Newsletter (Buttondown, Convertkit, Email Octopus, Klaviyo, Mailchimp, Revue)
  • Analytics (Google Analytics, Plausible Analytics, Simple Analytics, Umami Analytics, Posthog)
  • Comments (Disqus, Giscus, Utterances)
  • Search (Algolia, Kbar local search)

About

Create content rich websites with ease - built on next.js, contentlayer and tailwindcss

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 91.7%
  • JavaScript 5.9%
  • CSS 1.6%
  • Other 0.8%