wehub-resource-sync
13 KiB
Documentation prête pour la production à partir de Markdown, en quelques secondes.
Zero config. Native IA. Conçu pour les développeurs.
Site web · Documentation · Éditeur en direct · Agent Skills · Signaler un bug
Démarrage rapide
Lancez docmd dans n'importe quel dossier contenant des fichiers Markdown — aucune installation requise :
npx @docmd/core dev
Ouvre sur http://localhost:3000
_ _
_| |___ ___ _____ _| |
| . | . | _| | . |
|___|___|___|_|_|_|___|
v1.x.x
┌─ 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 semantic search index (multi-version)
└──────────────────────────────────────────────────────────
┌─ Publishing
│ [ DONE ] Generated robots.txt
│ [ DONE ] Generated .nojekyll (disables Jekyll on GitHub Pages)
│ [ DONE ] Generated sitemap
│ [ DONE ] Generating LLMs context files
└──────────────────────────────────────────────────────────
⬢ 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 votre structure de fichiers. Pas de fichier de configuration, pas de frontmatter obligatoire, pas de framework à apprendre.
Quand vous êtes prêt à publier :
npx @docmd/core build
Cela produit un site statique (SPA) hautement optimisé, prêt à être déployé sur Vercel, Cloudflare Pages, Netlify, GitHub Pages, ou n'importe quel hébergeur statique.
Prérequis : Node.js 18+
Ou installer globalement / via Docker
# Installer globalement via npm
npm install -g @docmd/core
# Ou via pnpm
pnpm add -g @docmd/core
# Lancer
docmd dev # démarrer le serveur de développement
docmd build # construire pour le déploiement
Ou via Docker :
docker run -p 3000:3000 ghcr.io/docmd-io/docmd:0.8.7
Épinglez une version pour des builds reproductibles.
Pourquoi docmd ?
| Fonctionnalité | docmd | Docusaurus | MkDocs | VitePress | Mintlify |
|---|---|---|---|---|---|
| Configuration requise | Aucune | docusaurus.config.js |
mkdocs.yml |
config.mts |
docs.json |
| Payload JS | ~18 ko | ~250 ko | ~40 ko | ~50 ko | ~120 ko |
| Navigation | SPA instantanée | React SPA | Rechargement complet | Vue SPA | SPA hébergée |
| Versioning | Natif | Natif (complexe) | Plugin mike | Manuel | Natif |
| i18n | Natif | Natif (complexe) | Basé sur plugin | Natif | Natif |
| Multi-projet | Natif | Plugin | Plugin | - | - |
| Recherche | Intégrée | Algolia (cloud) | Intégrée | MiniSearch | Cloud |
Contexte IA (llms.txt) |
Intégré | - | - | - | Intégré |
| Serveur MCP | Intégré | - | - | - | Intégré |
| Agent Skills | Intégré | - | - | - | - |
| Image Docker | Officielle | - | Officielle | - | - |
| Auto-hébergé | Oui | Oui | Oui | Oui | - |
| Coût | Libre (OSS) | Libre (OSS) | Libre (OSS) | Libre (OSS) | Freemium |
Fonctionnalités
Zéro config, démarrage instantané
Pointez docmd vers n'importe quel dossier de Markdown et il s'exécute. La navigation est générée automatiquement à partir de votre structure de fichiers. Vous pouvez écrire votre premier doc et l'avoir en ligne en moins d'une minute — pas de boilerplate, pas de pipeline de build à configurer, pas de décisions à prendre à l'avance.
Minuscule par défaut, rapide partout
Le payload JavaScript par défaut est de ~18 ko. Les pages naviguent comme une SPA instantanée. La sortie est du HTML statique — optimisé pour le SEO, avec sitemap, URLs canoniques et métadonnées Open Graph intégrées. Recherche full-text hors ligne intégrée, sans service cloud requis.
Native IA
docmd est conçu pour la façon dont la documentation est lue et utilisée aujourd'hui :
- Serveur MCP —
docmd mcpexpose votre documentation aux agents IA sur stdio, leur permettant de chercher, lire et valider le contenu directement. - Contexte (
llms.txt/llms-full.txt) — contexte complet de la documentation généré au build, prêt pour tout LLM. - Agent Skills — ensembles d'instructions modulaires pour les LLMs et les agents IDE (docmd-skills).
- Copier en Markdown / Copier le contexte — boutons en un clic dans le navigateur, optimisés pour coller dans un chat IA.
Conçu pour passer à l'échelle
- Internationalisation avec builds multilingues
- Versioning pour plusieurs versions de documentation
- Workspaces pour les monorepos et les configurations multi-projets
- Système de plugins pour étendre le comportement du cœur
- Support complet du theming, 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 # générer un nouveau docmd.config.json dans le dossier courant
docmd stop # arrêter les serveurs `docmd dev` / `docmd live` en cours
docmd doctor # vérification préalable : config + statut d'installation des plugins
docmd migrate # importer depuis Docusaurus, VitePress, MkDocs ou Starlight
docmd deploy # générer la configuration pour Docker, NGINX, Caddy, Vercel, Netlify
docmd validate # vérifier tous les liens internes
docmd mcp # exécuter comme serveur MCP sur stdio
docmd add <name> # installer un plugin ou un modèle
Plugins
La fonctionnalité principale repose sur un système de plugins robuste. L'essentiel est inclus par défaut, tandis que des plugins optionnels peuvent être ajoutés selon les besoins spécifiques.
| Plugin | Statut | Description |
|---|---|---|
search |
Cœur | Recherche full-text hors ligne avec correspondance approximative |
seo |
Cœur | Balises SEO et métadonnées Open Graph |
sitemap |
Cœur | Génère sitemap.xml |
git |
Cœur | Historique des commits Git et dates de dernière mise à jour |
analytics |
Cœur | Intégration légère d'analytics |
llms |
Cœur | Génération du contexte IA (llms.txt / llms-full.txt) |
mermaid |
Cœur | Support des diagrammes Mermaid |
openapi |
Cœur | Rendu de spécification OpenAPI 3.x au build |
okf |
Core | Bundles Open Knowledge Format pour agents IA (par locale) |
pwa |
Optionnel | Progressive Web App — navigation hors ligne |
threads |
Optionnel | Fils de discussion inline (par @svallory) |
math |
Optionnel | Rendu mathématique KaTeX / LaTeX |
Installer des plugins optionnels :
docmd add <plugin-name>
Créez le vôtre : Guide de développement de plugins
Configuration
Aucune configuration n'est requise pour commencer. Ajoutez un docmd.config.json (ou .ts / .js) à la racine de votre projet uniquement lorsque 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
my-docs/
├── docs/ ← Vos fichiers markdown
├── assets/ ← Images et fichiers statiques
├── docmd.config.json ← Configuration optionnelle
└── package.json
Éditeur en direct
Un éditeur basé sur navigateur pour écrire et prévisualiser la documentation — aucune configuration locale requise.
Essayez-le sur live.docmd.io
API programmatique
Utilisez docmd dans des scripts Node.js, des pipelines CI ou des étapes de build personnalisées. (Supporte CommonJS et ESM.)
import { build } from '@docmd/core';
await build('./docmd.config.json', { isDev: false });
Référence complète : Node API
Communauté
- Bugs et problèmes → GitHub Issues
- Questions et idées → Discussions
- Contribuer → CONTRIBUTING.md
- Roadmap → GitHub Discussions
Soutien
- Faire connaître docmd est la façon la plus directe 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 sponsorship GitHub est très appréciable.
- Des idées ou des bugs ? Ouvrez une issue ou une PR, n'hésitez pas à contribuer avec vos propres plugins.
Licence
MIT — voir LICENSE pour plus de détails.