Inicio rápido

Foldocs convierte Markdown y MDX determinista en una aplicación de documentación Foldkit completa con contenido tipado, navegación, búsqueda de texto completo y salidas legibles por IA.

Cada documento también está disponible como Markdown procesado añadiendo .md a su URL, con acciones para copiarlo y abrirlo generadas automáticamente.

Instalación automática

Crea una aplicación Foldocs completa con Foldkit, Effect, búsqueda local, salida estática, rutas Markdown y archivos para LLM ya configurados:

npm create foldocs@latest mis-docs
cd mis-docs
npm run dev

Qué incluye

Tipado de principio a fin

import { createDocsProgram } from 'foldocs'
import {
  basePath,
  i18n,
  landingSocialImages,
  manifest,
  navigations,
  og,
  searchIndexUrls,
  seo,
  siteConfig,
} from 'virtual:foldocs'

const program = createDocsProgram({
  basePath,
  i18n,
  landingSocialImages,
  manifest,
  navigations,
  og,
  searchIndexUrls,
  seo,
  site: siteConfig,
})

El manifiesto virtual contiene inmediatamente metadatos serializables y carga cada documento compilado de forma diferida solo cuando se visita su ruta.

Contenido estático desde la primera respuesta

Las compilaciones de producción prerenderizan cada ruta de inicio y documentación. La navegación directa recibe la página real en lugar de un documento de carga temporal.