Quickstart

This guide walks you through creating a documentation site with Chronoter and deploying it to the Platform.

1. Install the CLI

npm install -g chronoter

Verify the installation:

chronoter --version

2. Create a Project

Create a new directory and add a configuration file:

mkdir my-docs
cd my-docs

Create chronoter.config.json:

{
  "site": {
    "title": "My Docs",
    "description": "Team documentation"
  }
}

3. Create Your First Document

Create index.mdx:

---
title: Welcome
description: Welcome to the documentation
---
 
# Welcome
 
This is your first document.
 
## Features
 
- **MDX Support**: Write with Markdown + JSX
- **Fast Preview**: See changes instantly
- **AI Friendly**: Structured context for AI

4. Start the Development Server

chronoter dev

Open http://localhost:5173 in your browser to see your documentation.

Edit your files and see changes reflected instantly in the browser.

5. Prepare Your GitHub Repository

To deploy to the Platform, you need a GitHub repository:

git init
git add .
git commit -m "Initial commit"
git remote add origin https://github.com/your-org/my-docs.git
git push -u origin main

6. Deploy to the Platform

  1. Go to Chronoter Platform
  2. Enter your invite code and create an account
  3. Create an Organization and Project
  4. Connect your GitHub repository

Once connected, your documentation will automatically update with every push.

Next Steps