Dieser Leitfaden beschreibt alle Formatierungsoptionen, die in Discourse-Beiträgen verfügbar sind, einschließlich Markdown, BBCode und HTML. Er gibt an, was unterstützt wird, und bietet Ressourcen, in denen Sie Beispiele sehen können.
Erforderliche Benutzerebene: Alle Benutzer
Unterstützte Formatierung in Beiträgen verstehen
Obwohl einfacher Text für die meisten Antworten ausreicht, ermöglicht Discourse den Benutzern, die Formatierung ihrer Beiträge durch die Verwendung von Markdown, BBCode und HTML zu verbessern. Dieser Leitfaden erklärt, welche Arten von Formatierungen unterstützt werden und wie Sie diese effektiv nutzen können.
Sie können auch einige Grundlagen in einem interaktiven Tutorial üben, indem Sie eine private Nachricht an @discobot hier oder auf einer beliebigen Discourse-Seite senden.
Zusammenfassung
Dieser Leitfaden behandelt:
- Unterstützte Markdown-Syntax
- Unterstützte BBCode-Tags
- Unterstützte und sichere HTML-Tags und Attribute
Best Practices
- Verwenden Sie hauptsächlich Markdown wegen seiner Einfachheit und Lesbarkeit.
- Mischen Sie Markdown und BBCode nur bei Bedarf und halten Sie die Verwendung konsistent.
- Beschränken Sie die Verwendung von HTML auf einfache, sichere Tags, um Formatierungsprobleme zu vermeiden und sicherzustellen, dass Beiträge sicher sind.
Unterstütztes Markdown
Discourse verwendet markdown-it für seine Markdown-Implementierung.
Einige häufig verwendete Markdown-Funktionen umfassen:
-
Fett:
**text** -
Kursiv:
*text* -
Link:
[title](https://example.com) -
Inline-Code:`code` -
Hervorheben:
<mark></mark> -
Codeblock:
``` code block ```
In längeren Beiträgen (wie diesem) kann es auch hilfreich sein, mithilfe von Überschriften Struktur hinzuzufügen:
# Überschrift 1
## Überschrift 2
### Überschrift 3
Hinweis: Wenn ein Bild hochgeladen wird, wird die Markdown-Syntax zum Referenzieren des Bildes automatisch generiert.
Eine vollständige Liste der Markdown-Funktionen finden Sie im interaktiven Leitfaden.
Unterstützter BBCode
Discourse unterstützt eine Teilmenge gängiger BBCode-Tags, von denen einige automatisch generiert werden, um spezielle Formatierungen zu unterstützen, beispielsweise wenn Sie einen Beitrag in Ihrer Antwort zitieren:
[quote=“user”]quoted text[/quote]
[quote="user"]quoted text[/quote]
Sie können BBCode auch verwenden, um Text als Spoiler oder als Details zu markieren
spoiled text
[spoiler]spoiled text[/spoiler]
[details=“click to expand”]hidden text[/details]
[details="click to expand"]hidden text[/details]
BBCode-Tags für einfache Formatierungen, die von Markdown unterstützt werden oder ebenfalls unterstützt werden:
[b]stark[/b][i]Betonung[/i][u]unterstrichen[/u][s]durchgestrichen[/s][ul][li]Option eins[/li][/ul][img]http://example.com/image.png[/img][url]http://example.com[/url][code]code[/code]
Eine vollständige Liste der unterstützten BBCode-Tags und Beispiele finden Sie in den Discourse BBCode-Tests.
Unterstütztes HTML
Discourse unterstützt eine sichere Teilmenge von HTML. Obwohl Sie HTML mit Markdown mischen können, sind nur bestimmte HTML-Tags und Attribute zulässig, um Sicherheit und konsistente Formatierung zu gewährleisten.
Einige der erlaubten HTML-Tags umfassen:
<a href="https://example.com">link</a><strong>fetter Text</strong><em>kursiver Text</em><ul><li>Listenelement</li></ul><img src="https://example.com/image.png" alt="description">
Eine detaillierte Liste der erlaubten HTML-Tags und Attribute finden Sie in der Allow-Liste von Discourse.
Hinweis: Inline-Stile, wie <span>colored text</span>, werden nicht unterstützt. Für benutzerdefinierte Stile siehe Beitraginhalte anpassen.
Häufige Probleme und Lösungen
- BBCode- oder HTML-Tags funktionieren nicht: Stellen Sie sicher, dass die von Ihnen verwendeten Tags Teil der unterstützten Teilmenge sind.
- Inline-Stile werden entfernt: Discourse unterstützt Inline-Stile aus Sicherheitsgründen nicht. Verwenden Sie bei Bedarf benutzerdefinierte Stile oder Plugins.
- Formatierung ändert sich beim Einfügen aus anderen Editoren: Einige Rich-Text-Formate werden möglicherweise nicht korrekt gerendert. Verwenden Sie Markdown, um Text konsistent zu formatieren.
FAQs
F: Kann ich Tabellen in Discourse verwenden?
A: Ja, Sie können Markdown verwenden, um Tabellen zu erstellen. Weitere Informationen finden Sie in diesem Leitfaden zu Tabellen.
F: Warum funktioniert mein Inline-Stil nicht?
A: Discourse unterstützt Inline-Stile aus Sicherheitsgründen nicht. Erwägen Sie die Verwendung von benutzerdefiniertem BBCode oder dem Discourse-Leitfaden für benutzerdefinierte Stile.
F: Kann ich benutzerdefinierte BBCode-Tags hinzufügen?
A: Ja, Sie können benutzerdefinierte BBCode-Tags hinzufügen. Weitere Informationen finden Sie im Discourse BBCode-Plugin.
Zusätzliche Ressourcen
- Interaktiver Markdown-Leitfaden: https://markdown-it.github.io/
- Beitraginhalte anpassen: Customize posts' contents with your own styles
- Discourse BBCode-Plugin: Discourse BBCode
