Getting started

Use Node.js 24.14 or newer. Install Monoline Docs from npm in a new or existing project directory.

Create a site

1. Install the package in your project and initialize the site:

   npm install @chitrank2050/monoline-docs
   npx monoline-docs init

   For pnpm, use pnpm add @chitrank2050/monoline-docs followed by pnpm exec monoline-docs init.

2. Start the local preview:

   npm run dev

   Open the address printed in your terminal.

3. Edit content/index.md. Changes to content and assets rebuild the preview automatically; restart it after changing configuration.

Your project

The initializer creates the configuration, homepage and build/dev scripts. Existing conflicting configuration, homepages or scripts are rejected rather than overwritten. It does not install dependencies.

Write a page

Create content/installation.md:

---
title: Installation
description: Set up your project.
---

## Install

Follow the installation instructions for your project.

With generated navigation, the page appears in the sidebar. Read Writing pages for links, headings and MDX.

Build and publish

npm run build

Your static site is written to dist. Deploy this directory to a static host; follow Deployment for base paths and hosting recipes.

Next steps

• Arrange the navigation.
• Add your branding.
• Use authoring components.
• Look up configuration options.