Bilder und Dateien
Erfahren Sie, wo Sie Bilder, Icons und andere statische Dateien ablegen.
Ihre Dokumentation wird häufig Bilder, Screenshots, Diagramme oder herunterladbare Dateien benötigen.
Für Inhaltsdateien gilt eine einfache Hauptregel: Legen Sie sie in public/ ab und referenzieren Sie sie mit einem Pfad, der mit / beginnt.
Einen Bildordner hinzufügen
Erstellen Sie innerhalb Ihres Projekts einen images-Ordner in public/:
public/
└── images/Wenn der Ordner bereits existiert, können Sie ihn verwenden.
Eine Bilddatei hinzufügen
Kopieren Sie ein Bild in diesen Ordner.
Zum Beispiel:
public/images/my-image.pngDie Datei kann ein Screenshot, ein Diagramm, eine Illustration oder jedes beliebige Bild sein, das Sie auf einer Seite anzeigen möchten.
Das Bild auf einer Seite anzeigen
Öffnen Sie die Seite, die Sie zuvor erstellt haben:
content/en/my-first-page.mdFügen Sie dieses Markdown dort ein, wo das Bild erscheinen soll:
Speichern Sie die Datei. Wenn Ihr lokaler Server läuft, sollte die Vorschau automatisch aktualisiert werden.
Warum der Pfad mit / beginnt
Dateien in public/ sind vom Website-Stammverzeichnis aus verfügbar.
Das bedeutet, dass diese Datei:
public/images/my-image.pngFolgendermaßen referenziert wird:
Fügen Sie public nicht in den Markdown-Pfad ein.
Nützliche Bildbeschreibungen schreiben
Der Text in den eckigen Klammern wird Alt-Text genannt:
Schreiben Sie eine kurze Beschreibung dessen, was das Bild zeigt.
Zum Beispiel:
Guter Alt-Text hilft Lesern, die Bildschirmlesegeräte verwenden, und liefert Kontext, falls ein Bild nicht geladen werden kann.
Was ist mit Icons und Logos?
Icons folgen derselben public/-Regel wie Bilder. Siehe Icons, um zu erfahren, wie Komponenten wie Karten und Sequenzdiagramme sie verwenden.
Das Website-Logo funktioniert anders: Es befindet sich in config/assets/ statt in public/, da es zur Website-Oberfläche gehört und nicht zu einer bestimmten Seite. Siehe Assets und Branding, wenn Sie bereit sind, es zu ersetzen.