Skip to content

Commit 25223c5

Browse files
committed
de add readme files documentation
1 parent 39d6bed commit 25223c5

5 files changed

Lines changed: 52 additions & 0 deletions

File tree

88.5 KB
Loading
7.81 KB
Loading
213 KB
Loading
340 KB
Loading
Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
---
2+
sidebar_position: 3.5
3+
title: README-Dateien in Ordnern
4+
description: Erfahren Sie, wie README.md-Dateien in Ordnern in OpenCloud gerendert werden.
5+
---
6+
7+
# README-Dateien in Ordnern
8+
9+
Wenn ein Ordner eine Datei mit dem Namen `README.md` enthält, rendert OpenCloud deren Markdown-Inhalt oberhalb der Dateiliste.
10+
11+
<img src={require("./img/readme-files/readme-list-view.png").default} alt="README in der Listenansicht gerendert, während die Datei noch sichtbar ist" width="1920"/>
12+
13+
## README-Datei erstellen
14+
15+
1. Öffnen Sie den Ordner, in dem Sie das README hinzufügen möchten.
16+
2. Erstellen oder laden Sie eine Datei mit dem Namen `README.md` hoch.
17+
3. Fügen Sie Ihren Markdown-Inhalt hinzu und speichern Sie die Datei.
18+
19+
OpenCloud rendert den Inhalt, wenn der Ordner geöffnet oder aktualisiert wird.
20+
21+
## Unterstützter Dateiname
22+
23+
Der Dateiname muss genau so lauten:
24+
25+
```text
26+
README.md
27+
```
28+
29+
## Beispiel
30+
31+
Eine `README.md`-Datei kann zum Beispiel folgenden Markdown-Inhalt enthalten:
32+
33+
```markdown
34+
# Fotos
35+
36+
Dieser Ordner enthält visuelle Beispiele für Vorschauen und Doku-Screenshots.
37+
38+
Die Bilder werden verwendet, um das Verhalten der Listenansicht, der Kachelansicht und der Bildvorschau in OpenCloud zu zeigen.
39+
40+
## Dateien
41+
42+
- moon-surface-public-domain.jpg
43+
- rotated-chessboard-photo.jpg
44+
- vintage-computer-terminal.jpg
45+
- Space-Nebula.jpg
46+
```
47+
48+
## README-Bereich entfernen
49+
50+
Löschen oder benennen Sie `README.md` um, um den gerenderten Bereich zu entfernen.
51+
52+
<img src={require("./img/readme-files/readme-removed.png").default} alt="Ordner ohne den gerenderten README-Bereich" width="1920"/>

0 commit comments

Comments
 (0)