README.fr.md

Une documentation prête pour la production à partir de Markdown, en quelques secondes.
Zéro configuration. Conçu pour les développeurs. Nativement optimisé pour l'IA.

Site Web  ·  Documentation  ·  AI Cloud Relay  ·  Éditeur en direct  ·  Agent Skills  ·  Signaler un bug

✦ 0.9 Serie — IA, Automatisation & Sécurité

La série 0.9.x marque la transition de docmd d'un générateur de documentation compatible IA vers une plateforme de documentation conçue à la fois pour les humains et les agents d'IA.

La série introduit l'Assistant IA, permettant de consulter la documentation de façon conversationnelle via votre propre fournisseur, une IA locale, ou le docmd Cloud Relay pour les sites statiques sans backend dédié. Elle enrichit également l'écosystème IA de docmd avec le support MCP, la génération de contexte LLM, les Agent Skills et des formats de connaissances structurés.

En parallèle de l'IA, cette série se concentre sur la sécurité, la confidentialité et l'automatisation, tout en continuant d'améliorer l'expérience documentaire centrale, la recherche, le déploiement et les flux de travail des développeurs.

Suivre la feuille de route 0.9 →

Démarrage rapide

Exécutez docmd dans n'importe quel dossier contenant des fichiers Markdown — aucune installation requise :

npx @docmd/core dev

    _                 _ 
  _| |___ ___ _____ _| |
 | . | . |  _|     | . |
 |___|___|___|_|_|_|___|

 v0.9.0

BUILD
  Engine          JS
  Source          docs/
  Output          site/
  Versions        2 (06, 05)
  Locales         7 (en, hi, zh, es, de, ja, fr)

DATA INDEXING
  [ DONE ] Syncing git metadata
  [ DONE ] Building search index & RAG embeddings (multi-version)
  [ DONE ] Generating AI Assistant RAG context

PUBLISHING
  [ DONE ] Generated robots.txt
  [ DONE ] Generated .nojekyll (disables Jekyll on GitHub Pages)
  [ DONE ] Generated sitemap
  [ DONE ] Generating LLMs context files (llms.txt)
  [ DONE ] Generating OKF bundles

⬢ Initial build completed in 1.2s.

WATCHING
  Source          ./docs
  Config          ./docmd.config.json
  Assets          ./assets

DEVELOPMENT SERVER RUNNING
  Local Access    http://127.0.0.1:3000
  Network Access  http://192.168.1.6:3000
  Serving from    ./site

La navigation est générée à partir de la structure de vos fichiers. Aucun fichier de configuration, aucun frontmatter obligatoire, aucun framework à apprendre.

Quand vous êtes prêt à publier :

npx @docmd/core build

Génère un site statique hautement optimisé (SPA) prêt à être déployé sur Vercel, Cloudflare Pages, Netlify, GitHub Pages ou n'importe quel hébergeur statique.

Préréquis : Node.js 18+

# Installer globalement via npm
npm install -g @docmd/core

# Ou via pnpm
pnpm add -g @docmd/core

# Exécuter
docmd dev    # démarrer le serveur de développement
docmd build  # construire pour le déploiement

docker run -p 3000:3000 ghcr.io/docmd-io/docmd:0.9.0

Pourquoi docmd ?

Voir la Comparaison complète avec Docusaurus, Mintlify et autres →

Fonctionnalités

Zéro configuration, démarrage instantané

Pointez docmd vers n'importe quel dossier Markdown et il fonctionne. La navigation est construite automatiquement depuis votre arborescence. Vous pouvez rédiger votre premier document et le publier en moins d'une minute — sans code superflu, sans pipeline de build à configurer, sans décision préalable.

Ultra-léger par défaut, rapide partout

La charge utile JavaScript par défaut est d'environ 18 kb. La navigation entre les pages s'effectue sous forme de SPA instantanée. Le rendu produit du HTML statique — optimisé pour le SEO, incluant sitemap, URLs canoniques et métadonnées Open Graph. La recherche plein texte hors-ligne est intégrée, sans nécessiter de service cloud.

Conçu pour l'IA

docmd traite l'IA comme un moyen de premier ordre pour consommer la documentation — sans remplacer la documentation elle-même.

• Assistant IA (@docmd/plugin-ai) — Chat propulsé par RAG et ancré dans votre documentation. Utilisez votre propre clé API ou connectez un fournisseur d'IA local, avec le support de plus de 100 fournisseurs grâce à AIPlug.
• Cloud Relay — activez l'Assistant IA sur une documentation statique sans avoir à gérer votre propre backend IA. Essayer →
• Serveur MCP — docmd mcp expose vos documents aux agents d'IA via stdio, leur permettant de rechercher, lire et valider le contenu directement.
• Contexte (llms.txt / llms-full.txt) — contexte documentaire complet généré au moment du build.
• Agent Skills — jeux d'instructions modulaires pour les LLM et agents d'IDE.
• Open Knowledge Format (OKF) — paquets de connaissances structurés et multilingues pour les systèmes d'IA.
• Copier en Markdown / Copier le contexte — boutons d'extraction de contexte en un clic directement depuis le navigateur.

Conçu pour évoluer

• Internationalisation avec builds multi-locales (index de recherche par langue, llms, okf, hreflang)
• Gestion des versions pour plusieurs livraisons de documentation (détection automatique de la version courante)
• Workspaces pour les monorepos et configurations multi-projets
• Système de plugins pour étendre les fonctionnalités de base (validation des types de retour par hook, compatible async)
• Thématisation complète, modèles intégrés, CSS/JS personnalisé, mode clair/sombre

CLI

docmd dev            # serveur de développement local
docmd build          # construire pour le déploiement
docmd live           # Éditeur en direct basé sur le navigateur
docmd init           # initialiser un docmd.config.json dans le dossier actuel
docmd stop           # arrêter les serveurs `docmd dev` / `docmd live` en cours
docmd doctor         # diagnostic pré-vol : configuration + statut d'installation des plugins
docmd migrate        # migrer vers docmd depuis Docusaurus, VitePress, MkDocs ou Starlight
docmd deploy         # générer la configuration pour Docker, NGINX, Caddy, Vercel, Netlify
docmd validate       # vérifier l'intégralité des liens internes
docmd mcp            # exécuter en tant que serveur MCP via stdio
docmd add <nom>      # installer un plugin ou un modèle

Plugins

Les fonctionnalités de base sont propulsées par un système de plugins robuste. L'essentiel est inclus par défaut, et des plugins optionnels peuvent être ajoutés pour des besoins spécifiques.

Installer des plugins optionnels :

docmd add <nom-du-plugin>

Créez le vôtre : Guide de développement de plugins

Configuration

Aucune configuration n'est requise pour commencer. Ajoutez un fichier docmd.config.json (ou .ts / .js) à la racine de votre projet uniquement si vous avez besoin de plus de contrôle :

{
  "title": "Mon Projet",
  "url": "https://docs.monprojet.fr",
  "src": "./docs",
  "out": "./dist"
}

Les fichiers de configuration TypeScript et JavaScript sont pris en charge pour les valeurs dynamiques.

Référence complète : Aperçu de la configuration

Structure du projet

mes-docs/
├── docs/                ← Vos fichiers markdown
├── assets/              ← Images et fichiers statiques
├── docmd.config.json    ← Configuration optionnelle
└── package.json

Éditeur en direct (Live Editor)

Un éditeur basé sur le navigateur pour rédiger et prévisualiser votre documentation — aucune configuration locale nécessaire.

Essayez-le sur live.docmd.io

API programmatique

Utilisez docmd dans vos scripts Node.js, pipelines CI ou étapes de build personnalisées (compatible CommonJS et ESM).

import { build } from '@docmd/core';

await build('./docmd.config.json', { isDev: false });

Référence complète : API Node

Communauté

• Bugs & problèmes → Issues GitHub
• Questions & idées → Discussions
• Contribuer → CONTRIBUTING.md
• Feuille de route → Discussions GitHub

Soutenir le projet

• Faire connaître docmd est le moyen le plus direct de soutenir son développement. Partagez-le sur X avec vos amis ou attribuez-lui une étoile.
• Si docmd vous fait gagner du temps, un sponsoring GitHub est grandement apprécié.
• Des idées ou des bugs ? Ouvrez une issue ou une PR, et n'hésitez pas à proposer vos propres plugins.

Licence

Licence MIT. Consultez LICENSE pour plus de détails.