DocSite

Introduction

Welcome to DocSite β€” a high-performance, multi-language documentation platform built with Next.js App Router, ISR, and i18n.

What is DocSite?

DocSite is an open-source documentation framework designed to help teams create beautiful, fast, and globally accessible documentation. It leverages the latest Next.js features including Incremental Static Regeneration (ISR) and built-in internationalization.

Key Features

  • Blazing Fast Performance β€” Pages are statically generated and served from the CDN with ISR revalidation every 60 seconds.
  • Multi-Language Support β€” Full i18n for English, Spanish, French, and German via sub-path routing.
  • Version Management β€” Maintain v1, v2, and v3 documentation side-by-side.
  • Full-Text Search β€” Instant client-side search powered by FlexSearch.
  • Dark Mode β€” System preference detection plus manual toggle.
  • API Reference β€” Integrated Swagger UI from an OpenAPI 3.0 spec.
  • App Router β€” Built entirely on the Next.js App Router with React Server Components.

Architecture Overview

The platform is built on three core pillars:

  1. Static Generation with ISR β€” export const revalidate = 60 in every doc page.
  2. Content as Markdown β€” Docs live in _docs/{locale}/{version}/*.md.
  3. Containerized Deployment β€” Docker + docker-compose for one-command setup.

Quick ISR Example

// app/[locale]/docs/[version]/[slug]/page.tsx
export const revalidate = 60; // ISR: regenerate every 60 seconds

export default async function DocPage({ params }) {
  const doc = await getDocContent(params.locale, params.version, params.slug);
  return <DocContent html={doc.contentHtml} />;
}

System Requirements

Tool Minimum Version
Node.js 20.0
npm 10.0
Docker 24.0

Next Steps

Head to Getting Started to install and run the project locally.

Was this page helpful?