Highlight
Highlight ist eine Erweiterungssyntax in Markdown, die wichtige Text in Dokumenten hervorhebt. Sie hilft Lesern, schnell wichtige Informationen zu identifizieren, was Dokumente visueller und effektiver macht.
Grundlegende Syntax
Markierung von Highlights
In den meisten Markdown-Erweiterungen, die Hervorhebungen unterstützen, wird um den zu markierenden Text zwei Gleichheitszeichen (==
) gesetzt:
Dies ist ein Beispielabsatz, der ==hervorgehobenen Text== enthält.
Rendering-Effekt:
Dies ist ein Beispielabsatz, der ==hervorgehobenen Text== enthält.
Wort- und Phrasenhervorhebung
Hervorhebungen können auf einzelne Wörter oder Phrasen angewendet werden:
In der Programmierung sind ==Variablen== benannte Speicherplätze für Daten.
Bitte stellen Sie sicher, dass Sie die ==wichtigen Hinweise und Warnungen== in der Dokumentation lesen.
Rendering-Effekt:
In der Programmierung sind ==Variablen== benannte Speicherplätze für Daten.
Bitte stellen Sie sicher, dass Sie die ==wichtigen Hinweise und Warnungen== in der Dokumentation lesen.
Erweiterte Verwendung
Kombinieren mit anderen Formaten
Hervorhebungen können mit anderen Markdown-Formaten kombiniert werden:
==**Fette Hervorhebung**==
==*Kursive Hervorhebung*==
==***Fette Kursive Hervorhebung***==
==`Code Hervorhebung`==
==[Link Hervorhebung](https://www.markdownlang.com)==
Rendering-Effekt:
==Fette Hervorhebung==
==Kursive Hervorhebung==
==Fette Kursive Hervorhebung==
==Code Hervorhebung
==
Block-level Hervorhebung
Einige Markdown-Implementierungen erlauben die Anwendung von Hervorhebungen auf ganze blockförmige Inhalte, üblicherweise mit benutzerdefinierter Container-Syntax:
::: highlight
Dies ist ein hervorgehobener Absatzblock.
Er kann mehrere Zeilen Inhalt enthalten und kann sogar Listen enthalten:
- Element 1
- Element 2
- Element 3
:::
Hinweis: Die Unterstützung für blockförmige Hervorhebung variiert je nach Markdown-Prozessor. Der obige Beispiel ist auf Plattformen wie VitePress verfügbar, die benutzerdefinierte Container unterstützen.
Kompatibilität und Implementierungsdifferenzen
Unterstützungsstatus auf verschiedenen Plattformen
Plattform/Tool | Hervorhebungsunterstützung | Syntax |
---|---|---|
GitHub Markdown | ❌ | Nicht unterstützt |
GitLab Markdown | ✅ | ==highlight== |
Hugo | ✅ | Verwendet mark-Tag oder ==highlight== |
VitePress | ✅ | ==highlight== |
Pandoc | ✅ | ==highlight== oder [highlight]{.mark} |
Jekyll | ✅ | Abhängig vom Theme und verwendeten Plugins |
CommonMark | ❌ | Nicht unterstützt |
HTML-Ausgabe-Format
Die meisten Markdown-Prozessoren, die Hervorhebungen unterstützen, konvertieren hervorgehobenen Text in HTML mit <mark>
-Tags oder spezifischen CSS-Klassen:
<!-- Mit mark-Tag -->
<p>Dies ist ein Beispielabsatz, der <mark>hervorgehobenen Text</mark> enthält.</p>
<!-- Mit benutzerdefinierter Klasse -->
<p>Dies ist ein Beispielabsatz, der <span class="highlighted">hervorgehobenen Text</span> enthält.</p>
Alternative Syntax
Auf Plattformen, die die Hervorhebungssyntax nicht unterstützen, können Sie HTML-Tags als Alternativen verwenden:
Dies ist ein Beispielabsatz, der <mark>hervorgehobenen Text</mark> enthält.
<!-- Oder mit benutzerdefinierten Stilen -->
Dies ist ein Beispielabsatz, der <span style="background-color: yellow;">hervorgehobenen Text</span> enthält.
Verwendungsszenarien
Dokumenteinfärbung
Hervorhebungen eignen sich für das Einfärben wichtiger Inhalte in Dokumenten:
# Installationsanleitung
Bitte ==vollständig Ihre Daten== vor der Installation sichern. Der Systeminstallationsprozess formatiert das Zielpartition.
Installationsschritte:
1. Lade den Installer herunter
2. Führe den Installationsassistenten aus
3. ==Wähle "Benutzerdefinierte Installation" Option==
4. Folge den Bildschirmanweisungen zur vollständigen Installation
Rendering-Effekt:
Installationsanleitung
Bitte ==vollständig Ihre Daten== vor der Installation sichern. Der Systeminstallationsprozess formatiert das Zielpartition.
Installationsschritte:
- Lade den Installer herunter
- Führe den Installationsassistenten aus
- ==Wähle "Benutzerdefinierte Installation" Option==
- Folge den Bildschirmanweisungen zur vollständigen Installation
Bildungsmaterialien
Hervorhebungen sind besonders nützlich in Lehrmaterialien:
## Python Variablen
In Python wird die Variable `=` verwendet:
```python
x = 10 # Weise Wert 10 der Variablen x zu
==Python ist eine dynamisch typisierte Sprache, bei der die Typen der Variablen während der Zuweisung automatisch bestimmt werden.==
Gängige Variable-Typen sind:
- Ganzzahl (int)
- Gleitkommazahl (float)
- String (str)
- Boolean (bool)
### Textvergleich und Revision
Hervorhebungen können verwendet werden, um Änderungen oder Unterschiede in Dokumenten hervorzuheben:
```markdown
## Dokumentenversionvergleich
### Originalversion
Der Server wird jeden Sonntag um 2:00 Uhr gewartet.
### Aktualisierte Version
Der Server wird jeden Sonntag um 2:00 Uhr gewartet. ==Wartung ist für 2 Stunden erwartet.==
Rendering-Effekt:
Dokumentenversionvergleich
Originalversion
Der Server wird jeden Sonntag um 2:00 Uhr gewartet.
Aktualisierte Version
Der Server wird jeden Sonntag um 2:00 Uhr gewartet. ==Wartung ist für 2 Stunden erwartet.==
Zitate und Anmerkungen
Hervorhebungen können verwendet werden, um Schlüsselpunkte in Zitaten zu markieren:
> "Dies ist ein Zitatstext, ==wo dieser Teil besonders wichtig ist==, der Leser besondere Aufmerksamkeit erfordert."
>
> — Ein bekannter Autor
Rendering-Effekt:
"Dies ist ein Zitatstext, ==wo dieser Teil besonders wichtig ist==, der Leser besondere Aufmerksamkeit erfordert."
— Ein bekannter Autor
Stilanpassung
In Umgebungen, die CSS-Anpassungen unterstützen, können Sie die Stilung von hervorgehobenen Text anpassen:
/* Benutzerdefinierte Hervorhebungsstile */
mark, .highlighted {
background-color: #ffeb3b; /* Gelber Hintergrund */
color: #000; /* Schwarzer Text */
padding: 0 3px; /* Abstand */
border-radius: 3px; /* Abrundete Ecken */
}
/* Unterschiedliche Hervorhebungsarten */
.highlight-warning {
background-color: #ffcdd2; /* Rote Warnungshervorhebung */
}
.highlight-success {
background-color: #c8e6c9; /* Grüne Erfolgshervorhebung */
}
Mit benutzerdefinierten Stilen:
Dies ist <mark class="highlight-warning">Warnungsinformation</mark>, dies ist <mark class="highlight-success">Erfolgsinformation</mark>.
Best Practices
Verwendungsvorschläge
✅ Empfohlene Praktiken:
1. **Hervorhebungen moderat verwenden**:
- Nur wichtige Inhalte hervorheben
- Zu viele Hervorhebungen schwächen den Einfluss
2. **Konsistenz bewahren**:
- Verwende eine konsistente Hervorhebungsstil in Ihrem Dokument
- Verwende unterschiedliche Hervorhebungsstile für unterschiedliche Arten wichtiger Inhalte
3. **Mit Kontext kombinieren**:
- Stelle sicher, dass hervorgehobener Inhalt logische Verbindung mit dem Umfeld hat
- Sie können kurze Erklärungen hinzufügen, warum bestimmte Inhalte hervorgehoben werden
❌ Praktiken zu vermeiden:
1. Überlange Absätze oder ganze Kapitel hervorheben
2. Zu viele Hervorhebungen auf einer einzelnen Seite
3. Hervorhebungen zu unwichtigen Inhalten hinzufügen
4. Zu viele verschiedene Farben oder Stile von Hervorhebungen verwenden
Barrierefreiheit
Hervorhebungen können Lesebarkeit für einige Benutzer erschweren. Berücksichtigen Sie die folgenden Punkte:
- Stellen Sie sicher, dass ausreichende Kontraste zwischen Hervorhebungsfarben und Hintergrund bestehen
- Hervorhebungen sollten nicht allein durch Farbe Informationen vermitteln
- Berücksichtigen Sie zusätzliche Markierungen (wie Symbole oder Überschriften) für hervorgehobene Inhalte
- Testen Sie die Dokumentlesbarkeit in verschiedenen Lesemodi (wie dunkler Modus)
Allgemeine Problemlösungen
Hervorhebung nicht angezeigt
Wenn Ihre Hervorhebung nicht korrekt angezeigt wird:
- Überprüfen Sie, ob die Plattform
==
-Syntax für Hervorhebungen unterstützt - Versuchen Sie, HTML
<mark>
-Tags als Alternative zu verwenden - Stellen Sie sicher, dass keine Leerzeichen zwischen
==
und dem hervorgehobenen Text bestehen - Überprüfen Sie, ob das Dokument die korrekten CSS-Stile referenziert
Konflikte mit anderen Formaten
Hervorhebungen können manchmal mit anderen Formaten in Konflikt geraten:
<!-- Möglicherweise problematische Schreibweise -->
==**Komplexes [Format](https://www.markdownlang.com) Inhalt**==
<!-- Sicherere Schreibweise -->
<mark>**Komplexes [Format](https://www.markdownlang.com) Inhalt**</mark>
Block-level Hervorhebungsprobleme
Für Fälle, die eine Hervorhebung von ganzen Blöcken erfordern, wird empfohlen, HTML oder benutzerdefinierte Container zu verwenden:
<!-- Mit HTML -->
<div class="highlighted-block">
# Wichtiges Kapitel
Dies ist ein Inhaltsblock, der eine allgemeine Hervorhebung erfordert.
</div>
<!-- Oder mit benutzerdefinierten Containern (auf unterstützten Plattformen) -->
::: highlight
# Wichtiges Kapitel
Dies ist ein Inhaltsblock, der eine allgemeine Hervorhebung erfordert.
:::
Verwandte Syntax
- Emphasis - Textemphasissyntax (fett, kursiv)
- Blockquotes - Blockquote-Syntax
- HTML - HTML in Markdown verwenden
Tools und Plugins
- markdown-it-mark: Fügt Hervorhebungsunterstützung für markdown-it hinzu
- remark-highlight.js: Fügt Syntaxhervorhebung für Code hinzu
- gatsby-remark-highlight-code: Codehervorhebungsplugin in Gatsby
Zusammenfassung
Hervorhebungen sind eine effektive Erweiterungssyntax, die die Lesbarkeit und Sichtbarkeit wichtiger Informationen in Dokumenten verbessern kann. Obwohl nicht alle Markdown-Prozessoren die Hervorhebungssyntax nativ unterstützen, können wir ähnliche Effekte mit HTML-Tags und benutzerdefinierten CSS erreichen, in fast jeder Umgebung. Angemessene Verwendung von Hervorhebungen kann Lesern helfen, schnell wichtige Inhalte in Dokumenten zu finden, was die allgemeine Lese-Erlebnis verbessert.