Markdown Kodeblokke

Kodeblokke er essentielle for teknisk dokumentation, tutorials og alt indhold, der inkluderer kodeeksempler. Markdown giver flere måder at formatere kode på, fra simple inline kode til fulde kodeblokke med syntaksfremhævning.

Inline kode

For korte kodestykker inden for sætninger, brug enkelt backticks:

Brug `git status` kommandoen til at tjekke dit repository.
`console.log()` funktionen udskriver til konsollen.
Tryk `Ctrl+C` for at stoppe processen.

Resultat:

Brug git status kommandoen til at tjekke dit repository. console.log() funktionen udskriver til konsollen. Tryk Ctrl+C for at stoppe processen.

Afgrænsede kodeblokke

For multi-linje kode, brug tredobbelte backticks:

```
function greet(name) {
  console.log("Hej, " + name + "!");
}

greet("Verden");
```

Resultat:

function greet(name) {
  console.log("Hej, " + name + "!");
}

greet("Verden");

Syntaks fremhævning

Tilføj sprognavnet efter de åbnende backticks for syntaksfremhævning:

JavaScript

```javascript
function calculateSum(a, b) {
  return a + b;
}

const result = calculateSum(5, 3);
console.log(result); // Output: 8
```

Python

```python
def calculate_sum(a, b):
    return a + b

result = calculate_sum(5, 3)
print(result)  # Output: 8
```

Populære sprog identifikatorer

Sprog	Identifikator	Alternativ
JavaScript	javascript	js
Python	python	py
Java	java
C++	cpp	c++
C#	csharp	cs
HTML	html
CSS	css
SQL	sql
JSON	json
XML	xml
Shell	bash	sh
TypeScript	typescript	ts
React JSX	jsx
PHP	php
Go	go
Rust	rust
Swift	swift

Vigtige bemærkninger

Afgrænsede kodeblokke er den foretrukne metode til formatering af kode i Markdown, da de giver bedre syntaksfremhævning og er mere bredt understøttet på tværs af forskellige platforme.

Bedste praksis

1. Brug altid syntaksfremhævning

❌ Ingen syntaksfremhævning:

```
if (user.isLoggedIn) {
  showDashboard();
} else {
  showLoginForm();
}
```

✅ Med syntaksfremhævning:

```javascript
if (user.isLoggedIn) {
  showDashboard();
} else {
  showLoginForm();
}
```

2. Hold kodeeksempler fokuserede

❌ For meget irrelevant kode:

```javascript
// Masser af opsætningskode...
const express = require('express');
const app = express();
const PORT = 3000;

// ... mere opsætning ...

// Det faktiske eksempel (begravet i opsætning)
app.get('/api/users', (req, res) => {
  res.json({ users: [] });
});

// ... mere boilerplate ...
```

✅ Fokuseret på den vigtige del:

```javascript
// Opret et simpelt API endpoint
app.get('/api/users', (req, res) => {
  res.json({ users: [] });
});
```

Almindelige anvendelser

API dokumentation

Request:

POST /api/users
Content-Type: application/json

{
  "name": "John Doe",
  "email": "[email protected]"
}

Response:

{
  "id": 123,
  "name": "John Doe",
  "email": "[email protected]",
  "created_at": "2024-01-15T10:30:00Z"
}

Konfigurationsfiler

Opret en .env fil i din projektrod:

# Database konfiguration
DB_HOST=localhost
DB_PORT=5432
DB_NAME=myapp
DB_USER=postgres
DB_PASSWORD=password123

# API Keys
API_KEY=your_api_key_here
SECRET_KEY=your_secret_key_here

Fejlfinding

Almindelige problemer

1. Kode formaterer ikke: Tjek for korrekte backticks
2. Syntaksfremhævning virker ikke: Verificer sprogidentifikator
3. Kode ødelægger layout: Brug korrekte linjebrud

Escape backticks

Hvis du skal vise backticks i din kode:

Enkelt backtick eksempel:

• •
  Skriv: `kode`
• •
  Resultat: kode

Tredobbelt backticks eksempel:

• •
  Skriv: ```kodeblok```
• •
  Resultat: kodeblok

Backticks i inline kode:

• •
  Skriv: ``backtick``
• •
  Resultat: backtick

Kodeblokke er essentielle for teknisk dokumentation. Brug dem til at gøre dine kodeeksempler klare, læsbare og korrekt formaterede!

Endelig, lad os lære om linjebrud for at perfektionere din tekstformatering.