Markdown Code-Blöcke Leitfaden: Inline-Code, umzäunte Blöcke und Syntax-Highlighting

Die Code-Formatierung ist eines der stärksten Merkmale von Markdown. Ob Sie eine Funktion dokumentieren, einen Terminalbefehl anzeigen oder ein Tutorial schreiben, die Markdown-Code-Syntax hält den Code visuell unterschiedlich. Sie ist ordnungsgemäß formatiert und (auf den meisten Plattformen) syntaktisch hervorgehoben. Dieser Leitfaden behandelt alles über Markdown-Codeblöcke.

Inline-Code

Verpacken Sie einen kurzen Ausschnitt oder einen einzelnen Ausdruck in einen einzelnen Backtick:

Use `console.log()` to print output.
Set the variable with `const x = 42;`.
The file is saved as `README.md`.

Inline-Code stellt in einem Monospace-Schriftzug dar, der sich visuell vom umgebenden Text unterscheidet. Verwenden Sie es für:

• Funktions- und Methodennamen: addEventListener()
• Variablenbezeichnungen: isLoading
• Dateinamen: package.json
• Befehlsgegenstände: --verbose
• Kurzcode-Ausdrücke

Wenn Ihr Inline-Code einen Backtick enthält, verwenden Sie doppelte Backticks, um ihn zu verpacken:

`` `backtick inside` ``

Umzäunte Codeblöcke

Für Mehrzeilencode werden Dreifach-Backticks (`) verwendet, um den Block zu öffnen und zu schließen:

```
This is a code block.
It preserves all whitespace and line breaks.
No formatting is applied inside.
```

Die Eindrücke, die Abstände und die neuen Linien sind alle exakt erhalten.

Syntax hervorheben

Fügen Sie einen Sprachkennzeicher nach den öffnenden Dreifach-Backticks hinzu, um die Syntax-Highlighting zu aktivieren:

```python
def greet(name: str) -> str:
    return f"Hello, {name}!"

print(greet("World"))
```

```javascript
const greet = (name) => `Hello, ${name}!`;
console.log(greet("World"));
```

```bash
#!/bin/bash
echo "Hello, World!"
ls -la ~/Documents
```

Gemeinsame Sprachkennzeichen

Eingeschränkte Codeblöcke

Eine ältere Markdown-Syntax verwendet für Codeblöcke einen 4-Spazzensatz:

    function oldStyle() {
        return "This is a code block";
    }

Dies ist CommonMark-kompatibel, aber weniger lesbar und unterstützt keine Sprachidentifikatoren. Verwenden Sie stattdessen eingezäunte Blöcke (dreifache Backsticks).

Code aus Word-Dokumenten konvertieren

Monospace-Text in Word (Courier New, Consolas usw.) wird in Inline-Code umgewandelt, wenn Sie WordToMD. Multi-line code in Word converts depending on how it was formatted:

• Monospace-Schriftartikel → Kann mehrere Inline-Code-Snippets werden
• Word Code-Stil → Konvertiert in einen Code-Block
• Wortwörtlicher Textblock → Kann manuelle Zäune benötigen

Nach der Umwandlung überprüfen Sie die Codeabschnitte und fügen Sie gegebenenfalls entsprechende Zäune hinzu:

1. Finden Sie den Code, der ein Block sein sollte
2. Umhüllen Sie es mit Dreifach-Backticks
3. Hinzufügen der entsprechenden Sprachkennzeichnung

Sprachspezifische Beispiele

HTTP-Anfragen

```http
POST /api/users HTTP/1.1
Host: api.example.com
Content-Type: application/json
Authorization: Bearer TOKEN

{
  "name": "Alice",
  "email": "alice@example.com"
}
```

Terminal-Befehle

```bash
npm install
npm run build
npm run dev
```

Diff-Ausgangsleistung

```diff
- const oldValue = "hello";
+ const newValue = "world";
  console.log(newValue);
```

YAML-Konfiguration

```yaml
server:
  host: localhost
  port: 8080
  debug: true
database:
  url: postgresql://localhost:5432/mydb
```

Eingebettete Codeblöcke (für die Dokumentation)

Bei der Dokumentation von Markdown selbst verwenden Sie 4 Backticks, um einen Block zu wickeln, der 3 Backticks enthält:

````markdown
```python
# This is a code block inside documentation
```
````

Plattformunterstützung

Zeilennummern

Standard Markdown unterstützt keine Zeilenzahlen in Codeblöcken. Einige Plattformen und statische Site-Generatoren fügen dies über Plugins hinzu:

• Prism.js (von vielen SSG genutzt) hinzufügen {numberLines: true} in der Code-Zäune
• GitHub keine native Zeilenummern in der dargestellten Markdown (verwenden Sie stattdessen GitHub Blame-Ansicht)
• GitBook Zeilennummern über Code-Block-Einstellungen

Code aus Blöcken kopieren

GitHub und viele Plattformen fügen automatisch einen Copy-Button zu Codeblöcken hinzu. Dies ist eine Rendering-Erweiterung es erfordert nichts Besonderes in Ihrem Markdown.

FAQ

Warum ist meine Code-Block-Syntax nicht markiert? Entweder fehlt der Sprachkennzeicher oder er ist falsch geschrieben, oder die Plattform unterstützt die bestimmte Sprache nicht. Überprüfen Sie die Identifikationsliste oben.

Wie zeige ich Backticks in einem Code-Block? Innerhalb eines eingezäunten Codeblocks werden Backticks als wörtliche Zeichen behandelt. Nur der Zaun mit den drei Rückstäben benötigt eine besondere Handhabung.

Mein Word-Dokument hatte farbenfrohen, syntaktisch hervorgehobenen Code. Wird WordToMD die Farben erhalten? Keine Markdown-Code-Blöcke bewahren die Farbformatierung nicht. WordToMD konvertiert den Text in einen Code-Block; Die Syntax-Highlighting wird dann vom Markdown-Renderer auf der Grundlage des Sprach-Identifikators angewendet.

Kann ich bestimmte Zeilen innerhalb eines Code-Blocks markieren? Standard Markdown unterstützt dies nicht. Einige Plattformen (wie Astro mit Shiki oder Hugo) unterstützen die Linie, die über Kommentare hervorgehoben wird: {1,3-5} nach der Sprachkennzeichnung.

Verwandte Leitfäden

• Markdown Syntax Kurzübersicht Vollständige Bezugnahme
• Word bis API Dokumentation codeintensive Dokumentation
• Word bis GitHub Markdown GitHub-spezifische Codeformatierung

Schlußfolgerung

Markdown-Code-Blöcke sind einfach: Backticks für Inline-Code, Dreifach-Backticks mit einem Sprachkennzeichen für Blöcke. Nach dem Konvertieren eines Word-Dokumentes mit WordToMD, überprüfen, ob der Monospace-Text in der Code-Syntax korrekt eingehalten wurde, und fügen Sie Sprach-Identifikatoren für die richtige Syntax-Highlighting auf Ihrer Ziel-Plattform hinzu.