Installation

Installez DocAnvil et créez votre premier site de documentation.

Installer DocAnvil

# Installer depuis crates.io (une fois publié)
cargo install docanvil

# Compiler depuis les sources
git clone https://github.com/docanvil/docanvil.git
cd docanvil
cargo install --path .

Vérifiez l'installation :

docanvil --help

Créer un projet

Créez un nouveau projet de documentation avec docanvil new :

docanvil new mes-docs

Cela génère la structure suivante :

mes-docs/
  docanvil.toml        # Configuration du projet
  nav.toml             # Structure de navigation
  docs/                # Votre contenu Markdown
    index.md           # Page d'accueil
    guides/
      getting-started.md
      configuration.md
  theme/
    custom.css         # Vos surcharges CSS

Lancer le serveur de développement

cd mes-docs
docanvil serve

Le serveur de développement démarre par défaut sur http://localhost:3000. Vous pouvez changer l'hôte et le port :

docanvil serve --host 0.0.0.0 --port 8080

Écrire votre première page

Créez un nouveau fichier Markdown n'importe où dans le répertoire docs/ :

# Ma nouvelle page

Bienvenue dans ma documentation !

- Prend en charge le texte **gras**, *italique*, et ~~barré~~
- Ajoutez des liens vers d'autres pages avec la syntaxe wiki-link

Enregistrez le fichier et votre navigateur se rechargera automatiquement. La page est découverte et ajoutée à la navigation.

Compiler pour la production

Quand vous êtes prêt à déployer, générez le site statique :

docanvil build

La sortie va dans le répertoire dist/ par défaut. Téléversez-le sur n'importe quel hébergeur statique — GitHub Pages, Netlify, Vercel, S3, ou un simple serveur web.

Utilisez --clean pour supprimer le répertoire de sortie avant de compiler :

docanvil build --clean

Pour les pipelines CI/CD, utilisez --strict pour faire échouer le build lorsqu'il y a des avertissements :

docanvil build --strict

Checklist

• Installer DocAnvil
• Lancer docanvil new pour créer un projet
• Démarrer le serveur de développement avec docanvil serve
• Écrire vos pages en Markdown
• Personnaliser le thème
• Compiler et déployer avec docanvil build

Prochaines étapes

• Configurez votre projet et votre navigation
• Découvrez les fonctionnalités Markdown et les composants
• Personnalisez le thème pour correspondre à votre identité visuelle