Skip to main content

Organisieren von Informationen mit reduzierten Abschnitten

Optimiere Markdown, indem du einen reduzierten Abschnitt mit dem Tag <details> erstellst.

Wer kann dieses Feature verwenden?

Markdown kann auf der Webbenutzeroberfläche von GitHub verwendet werden.

Erstellen eines reduzierten Abschnitts

Du kannst Markdownabschnitte vorübergehend ausblenden, indem du einen reduzierten Abschnitt erstellst, den Leserinnen erweitern können. Wenn du beispielsweise technische Details in einen Issuekommentar einfügen möchtest, die möglicherweise nicht für alle Leserinnen relevant oder interessant sind, kannst du diese Details in einen reduzierten Abschnitt einfügen.

Alle Markdowns innerhalb des <details>-Blocks werden reduziert, bis der Leser auf klickt, um die Details zu erweitern.

Verwende innerhalb des <details>-Blocks das <summary>-Tag, um die Leser*innen über den Inhalt zu informieren. Die Bezeichnung wird rechts neben angezeigt.

<details>

<summary>Tips for collapsed sections</summary>

### You can add a header

You can add text within a collapsed section. 

You can add an image or a code block, too.

```ruby
   puts "Hello World"
```

</details>

Der Markdown in der <summary>-Bezeichnung ist standardmäßig reduziert:

Screenshot des obigen Markdowns auf dieser Seite, wie auf GitHub gerendert, mit einem Pfeil nach rechts und der Kopfzeile „Tipps für reduzierte Abschnitte“.

Nachdem Leser*innen auf klicken, werden die Details eingeblendet:

Screenshot des oben auf dieser Seite gerenderten Markdowns auf GitHub, der darauf hinweist, dass ein reduzierter Abschnitt Überschriften, Textsätze, Bilder und Codeblöcke enthalten kann.

Wenn der Abschnitt standardmäßig als geöffnet angezeigt werden soll, können Sie optional dem Tag <details> das Attribut open hinzufügen.

<details open>

Weitere Informationsquellen