llovvoll / pliny

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

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

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:

pliny install add-blog ContentDir=data ContentName=blog

Add the blog-classic templates to the layouts folder:

pliny install blog-classic

Features

  • Best in class developer experience for building a markdown website, courtesy of contentlayer, including:
    • 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)
  • Out of the box templates based on Next.js and Tailwindcss
  • Full suite of markdown plugins including
  • React components for common services
    • Newsletter (Buttondown, Convertkit, Email Octopus, Klaviyo, Mailchimp, Revue)
    • Analytics (Google Analytics, Plausible Analytics, Simple Analytics, Umami Analytics)
    • Comment system (Disqus, Giscus, Utterances)

About

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

License:MIT License


Languages

Language:TypeScript 92.0%Language:JavaScript 6.1%Language:CSS 1.0%Language:Shell 0.6%Language:TeX 0.2%Language:Batchfile 0.0%