Getting Started

Quickstart

Get up and running in under five minutes.

Prerequisites

Before you begin, make sure you have:

• Node.js version 18 or higher
• A GitHub account
• A text editor

Step 1: Install the CLI

Open your terminal and run:

npm install -g example-cli

Step 2: Initialize your project

Create a new project in your desired directory:

example-cli init my-project
cd my-project

Step 3: Start the development server

example-cli dev

Your site is now running at http://localhost:3000.

Step 4: Make your first edit

Open docs/index.md in your text editor and make a change. The browser will automatically reload.

Next steps

Now that you have a running project, explore these topics:

• Format Text — Learn markdown formatting
• Code Blocks — Syntax highlighting and code groups
• Components — Callouts, tabs, and more