Jamdesk Documentation logo

Aperçu de la configuration du projet

Créez un projet, connectez GitHub, organisez votre repo et décidez qui peut lire la documentation. Commencez ici si le site n'est pas encore en ligne.

Chaque site Jamdesk démarre de la même façon : un projet dans le dashboard, un repo GitHub derrière, et un fichier docs.json qui décrit votre navigation. Cette section couvre cette configuration initiale, ainsi que les décisions structurelles à prendre tôt. La structure des URL, les langues et le contrôle d'accès sont bien plus faciles à définir avant d'avoir cinquante pages qu'après.

Vous migrez depuis une autre plateforme ? Passez directement au Guide de migration. Jamdesk peut automatiser la majeure partie de la conversion.

Du repo au site en ligne

1
Créer un projet

Partez d'un modèle ou connectez un repo GitHub existant. Votre site est mis en ligne à l'adresse yourproject.jamdesk.app.

2
Connecter GitHub

Installez l'application GitHub pour que chaque push soit déployé automatiquement.

3
Organiser le repo

Un fichier docs.json et des pages MDX. C'est tout le contrat.

Configuration de base

Créer un projet

D'un modèle ou d'un repo existant à un site en ligne

Connecter GitHub

Installation de l'application, accès au repo et déploiements automatiques à chaque push

Structure des répertoires

Fichiers requis, répertoires de pages, images et snippets

Guide de migration

Migrez depuis une autre plateforme de documentation, de façon automatisée ou manuelle

Prise en charge des monorepos

Gardez la documentation à côté de votre code quand elle n'est pas à la racine du repo

Prise en charge multilingue

Servez la documentation en plusieurs langues avec un sélecteur de langue

Structure du site

Navigation

Onglets, groupes et pages qui organisent votre documentation

Redirections

Redirections exactes ou basées sur des motifs pour les pages déplacées ou renommées

Confidentialité et accès

Contrôle d'accès

Entièrement public, protégé par mot de passe, mixte ou SSO. Comparez les options.

Protection par mot de passe

Verrouillez tout le site ou seulement quelques pages derrière un mot de passe partagé

Authentification unique (SSO)

SAML ou OIDC via votre fournisseur d'identité