Installation

Getting Started

Project structure

The project is structured as a monorepo and includes the following packages:

site: main site built with Next.js and Tailwind CSS. You will deploy site
ui: a package that provides a Blog UI library, built using Tailwind CSS.
eslint-config-custom: eslint configurations (includes eslint-config-next and eslint-config-prettier)
tsconfig: tsconfig.jsons used throughout the monorepo

Prerequisites

Before installing Metablog, please ensure that you have the latest version of pnpm, npm, or yarn installed on your system. You can install the latest version of pnpm, npm, or yarn by running the following command in your terminal:

pnpm Installation (Recommended)

npm install pnpm@latest -g

Quick Start Video

Installing Metablog is easy and straightforward. If you're using pnpm, simply run the following command in your terminal from the project root:

pnpm install

💡

If you're using npm or yarn and you want to change the workspace setting in your package.json file, you can do so by modifying the following line: From: "blog-ui": "workspace:* To: "blog-ui": "*"

Build

To build all apps and packages, run the following command:

cd my-project
pnpm run build

Develop

To develop all apps and packages, run the following command:

cd my-project
pnpm run dev

These commands will start a local development server and allow you to start developing your Metablog-powered blog.

Thank you for choosing Metablog as your headless blog theme! If you have any questions or issues, please contact our support team.

Introduction Customization