Installation

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

Installer DocAnvil

Les scripts d'installation téléchargent un binaire précompilé pour votre plateforme (environ 5 Mo), le vérifient avec les sommes de contrôle SHA-256 publiées avec la version, et l'ajoutent à votre PATH. Aucune chaîne d'outils Rust n'est nécessaire.

curl -fsSL https://github.com/docanvil/docanvil/releases/latest/download/install.sh | sh

Installe dans ~/.local/bin. Si ce dossier n'est pas encore dans votre PATH, le script vous indique la ligne à ajouter à votre profil shell.

irm https://github.com/docanvil/docanvil/releases/latest/download/install.ps1 | iex

Installe dans %LOCALAPPDATA%\docanvil\bin et l'ajoute à votre PATH utilisateur. Ouvrez ensuite un nouveau terminal.

# Compile DocAnvil et ses dépendances (nécessite une chaîne d'outils Rust)
cargo install docanvil

git clone https://github.com/docanvil/docanvil.git
cd docanvil
cargo install --path .

Vérifiez l'installation :

docanvil --help

Options d'installation

Option	Variable d'environnement	Effet
`--version 1.2.0`	`DOCANVIL_VERSION`	Installer une version précise plutôt que la dernière
`--install-dir DIR`	`DOCANVIL_INSTALL_DIR`	Installer ailleurs, par exemple `/usr/local/bin` en CI
`--force`		Réinstaller même si cette version est déjà présente
`--quiet`		N'afficher que les erreurs

Passez des options au script redirigé avec sh -s -- :

curl -fsSL https://github.com/docanvil/docanvil/releases/latest/download/install.sh | sh -s -- --version 1.2.0

Sous Windows, définissez les variables d'environnement avant de lancer la commande (par exemple $env:DOCANVIL_VERSION = "1.2.0").

Relancer le script alors que cette version est déjà installée ne fait rien et se termine sans erreur : vous pouvez l'utiliser sans risque en CI.

Téléchargement manuel

Vous préférez ne pas exécuter un script directement dans votre shell, ou vous travaillez sur une machine verrouillée ? Chaque version publiée fournit une archive précompilée par plateforme :

Plateforme	Archive
macOS (Apple Silicon)	`docanvil-vX.Y.Z-aarch64-apple-darwin.tar.gz`
macOS (Intel)	`docanvil-vX.Y.Z-x86_64-apple-darwin.tar.gz`
Linux x86_64 (toutes distributions, y compris Alpine)	`docanvil-vX.Y.Z-x86_64-unknown-linux-musl.tar.gz`
Linux ARM64 (toutes distributions)	`docanvil-vX.Y.Z-aarch64-unknown-linux-musl.tar.gz`
Windows x86_64 (fonctionne aussi sous Windows ARM)	`docanvil-vX.Y.Z-x86_64-pc-windows-msvc.zip`

Téléchargez l'archive et le fichier SHA256SUMS de la version, vérifiez l'archive, puis placez le binaire dans un dossier de votre PATH :

VERSION=1.1.4                 # la version souhaitée
TARGET=aarch64-apple-darwin   # d'après le tableau ci-dessus
BASE=https://github.com/docanvil/docanvil/releases/download/v$VERSION
<p>curl -fLO "$BASE/docanvil-v$VERSION-$TARGET.tar.gz"
curl -fLO "$BASE/SHA256SUMS"
shasum -a 256 -c --ignore-missing SHA256SUMS   # ou : sha256sum -c --ignore-missing SHA256SUMS</p>
<p>tar -xzf "docanvil-v$VERSION-$TARGET.tar.gz"
mkdir -p ~/.local/bin && mv docanvil ~/.local/bin/

La vérification doit afficher OK. Si vous avez téléchargé l'archive avec un navigateur sous macOS, retirez l'attribut de quarantaine avant de lancer le binaire : xattr -d com.apple.quarantine ~/.local/bin/docanvil.

$Version = "1.1.4" $Asset = "docanvil-v$Version-x86_64-pc-windows-msvc.zip" $Base = "https://github.com/docanvil/docanvil/releases/download/v$Version" Invoke-WebRequest "$Base/$Asset" -OutFile $Asset Invoke-WebRequest "$Base/SHA256SUMS" -OutFile SHA256SUMS (Get-FileHash $Asset -Algorithm SHA256).Hash.ToLower() Select-String $Asset SHA256SUMS

Expand-Archive $Asset -DestinationPath "$env:LOCALAPPDATA\docanvil\bin" -Force

Les deux empreintes doivent être identiques. Ajoutez ensuite %LOCALAPPDATA%\docanvil\bin à votre PATH utilisateur.

Les versions jusqu'à v1.1.3 n'ont pas de fichier SHA256SUMS. Pour celles-ci, comparez avec l'empreinte SHA-256 affichée par GitHub à côté de chaque fichier sur la page de la version.

Mettre à jour

docanvil update          # chercher une nouvelle version et mettre à jour, avec confirmation
docanvil update --check  # indiquer seulement si une nouvelle version existe
docanvil update --yes    # mettre à jour sans confirmation

docanvil serve affiche aussi une ligne d'information quand une nouvelle version est disponible. La vérification a lieu au plus une fois par jour et jamais en CI. Définissez DOCANVIL_NO_UPDATE_CHECK=1 pour la désactiver.

Si vous avez installé DocAnvil avec cargo install, mettez-le à jour avec cargo install docanvil --force.

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

Note

DocAnvil surveille tous les fichiers de votre projet. Les modifications apportées aux fichiers Markdown, aux fichiers de configuration, au CSS et aux templates déclenchent toutes un rechargement en direct.