Clip

Getting Started

Set up Clip and publish your first article.

Prerequisites

  • Node.js 18 or later
  • A GitHub account
  • A Vercel account (free tier is fine)

Local setup

Clone or fork the repository, then install dependencies:

npm install
npm run dev

The dev server starts at http://localhost:3000. Any markdown file you add to contents/ appears in the sidebar immediately on save.

Writing your first article

Create a file at contents/01-introduction/03-my-article.md:

---
title: My First Article
description: A brief description for SEO.
date: 2024-01-15
---
 
Write your content here in **Markdown**.

The frontmatter fields:

Field Required Description
title Yes Displayed as the page title and in the sidebar
description No Used for SEO meta tags
date No Shown below the title

Deploying to Vercel

  1. Push the repository to GitHub
  2. Go to vercel.com and import the repo
  3. Vercel auto-detects Next.js — click Deploy
  4. Every future git push triggers a new deployment automatically

That's it. Your site is live.