Ein Projekt erstellen
Erstellen Sie ein Jamdesk-Projekt aus einer Vorlage oder verbinden Sie ein bestehendes GitHub-Repo. Ihre Website ist in wenigen Minuten unter yourproject.jamdesk.app erreichbar.
Bevor Sie Dokumentation schreiben, benötigen Sie ein Projekt. Starten Sie mit einer Vorlage, damit Jamdesk das Repo auf GitHub oder Bitbucket Cloud anlegt. Alternativ verbinden Sie ein bestehendes Repository, das bereits eine docs.json enthält. Ihre Website ist innerhalb weniger Minuten live. Um ohne GitHub-Konto zu starten, lesen Sie Dokumentation ohne GitHub.
Ein neues Projekt erstellen
Rufen Sie dashboard.jamdesk.com auf und melden Sie sich mit Ihrem GitHub-Konto an.
Beim ersten Anmelden fordert Jamdesk Sie auf, die Jamdesk GitHub App zu autorisieren.
Klicken Sie im Dashboard oben rechts auf New Project.
Beginnen Sie mit einer vorgefertigten Vorlage. Jamdesk erstellt ein neues GitHub-Repository mit Beispielinhalten, Navigation und bereits konfigurierten Komponenten.
Die Standard-Starter-Vorlage enthält Beispielseiten, eine OpenAPI-Spezifikation und Beispiele für jede Komponente. Ersetzen Sie die Inhalte durch Ihre eigenen.
Legen Sie die Grundinformationen Ihres Projekts fest:
| Feld | Beschreibung |
|---|---|
| Name | Anzeigename im Dashboard |
| Slug | URL-freundlicher Bezeichner (z. B. my-docs) |
| Domain | Ihre *.jamdesk.app-Subdomain |
Minimale Repository-Struktur
Ein Jamdesk-Projekt benötigt nur eine docs.json und mindestens eine Seite:
my-docs/
├── docs.json
└── introduction.mdxBeispiel für eine docs.json:
{
"$schema": "https://jamdesk.com/docs.json",
"name": "My Docs",
"theme": "jam",
"navigation": {
"groups": [
{
"group": "Getting Started",
"pages": ["introduction"]
}
]
}
}Projekteinstellungen
Konfigurieren Sie Ihr Projekt unter Settings:
Allgemein
- Name: Anzeigenamen aktualisieren
- Slug: Projektbezeichner ändern
- Delete Project: Projekt dauerhaft entfernen
Repository
- Branch: Branch, der Deployments auslöst
- Docs Path: Speicherort der
docs.jsonfür Monorepos
Domain
- Subdomain: Ihre
*.jamdesk.app-URL - Custom Domain: Eigene Domain hinzufügen
- Host at a subpath: Dokumentation unter einem Pfad wie
/docsoder/helpstatt im Stammverzeichnis bereitstellen
Build
- Show Jamdesk Branding: Den Link „Powered by Jamdesk“ in Ihrer Fußzeile anzeigen (standardmäßig aktiviert)
- Rebuild: Einen neuen Build manuell auslösen
Änderungen an den Build-Einstellungen werden erst nach einem neuen Build wirksam.
Projektlimits
Der Pro-Tarif umfasst ein Projekt. Weitere können Sie mit Projekt-Add-ons für jeweils 15 $/Monat hinzufügen.