Docgo is a static documentation site generator built on React, MDX, and Vite. It reads Markdown or MDX files from your docs directory and writes deployable HTML, assets, markdown mirrors, and SEO files to the output directory.

Requirements

Node.js 20 or newer is recommended.
Install react and react-dom with Docgo.
Use .md or .mdx files for documentation content.

Create a Docgo site

Install

npm install @kyechan99/docgo

If your project uses pnpm or yarn, install the same packages with your package manager.

Create starter files

npx @kyechan99/docgo init

The initializer creates files only when they do not already exist:

docgo.config.mjs
head.html
public/favicon.png
public/logo.png
docs/index.mdx
starter guide pages under docs/guide

Run locally

npx docgo dev

The dev server uses Vite middleware and reloads config/content changes during development. Use it while editing docs, navigation, and theme settings.

Build

npx docgo build

By default Docgo reads from docs and writes the production site to dist. The output includes:

static HTML pages with clean URLs
copied files from public
generated client assets
assets/search-index/<locale>/<version>.json when search is enabled
one .md mirror per page
sitemap.xml, robots.txt, and llms.txt when enabled

Minimal config

docgo.config.mjs

import { defineConfig } from '@kyechan99/docgo';

export default defineConfig({
  title: 'My Docs',
  description: 'Documentation for my project',
});

First page

Create docs/index.mdx:

---
title: Home
description: Welcome to the docs.
---

# Welcome

This is the first page of the documentation.

This file is served at /.

Getting Started

#Requirements

#Create a Docgo site

#Install

#Create starter files

#Run locally

#Build

#Minimal config

#First page