Markdown Codeblokken

Codeblokken zijn essentieel voor technische documentatie, tutorials en elke inhoud die codevoorbeelden bevat. Markdown biedt verschillende manieren om code op te maken, van eenvoudige inline code tot volledige codeblokken met syntax highlighting.

Inline Code

Voor korte code snippets binnen zinnen, gebruik enkele backticks:

Gebruik het `git status` commando om je repository te controleren.
De `console.log()` functie print naar de console.
Druk op `Ctrl+C` om het proces te stoppen.

Resultaat:

Gebruik het git status commando om je repository te controleren. De console.log() functie print naar de console. Druk op Ctrl+C om het proces te stoppen.

Omheinde Codeblokken

Voor multi-line code, gebruik drievoudige backticks:

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

greet("Wereld");
```

Resultaat:

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

greet("Wereld");

Syntax Highlighting

Voeg de taalnaam toe na de openende backticks voor syntax highlighting:

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
```

Populaire Taal Identificaties

Taal	Identificatie	Alternatief
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

Belangrijke Opmerkingen

Omheinde codeblokken zijn de voorkeursmethode voor het opmaken van code in Markdown omdat ze betere syntax highlighting bieden en breder ondersteund worden op verschillende platforms.

Beste Praktijken

1. Gebruik Altijd Syntax Highlighting

❌ Geen syntax highlighting:

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

✅ Met syntax highlighting:

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

2. Houd Codevoorbeelden Gefocust

❌ Te veel irrelevante code:

```javascript
// Veel setup code...
const express = require('express');
const app = express();
const PORT = 3000;

// ... meer setup ...

// Het eigenlijke voorbeeld (begraven in setup)
app.get('/api/users', (req, res) => {
  res.json({ users: [] });
});

// ... meer boilerplate ...
```

✅ Gefocust op het belangrijke deel:

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

Veelgebruikte Toepassingen

API Documentatie

Request:

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

{
  "name": "Jan Jansen",
  "email": "[email protected]"
}

Response:

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

Configuratiebestanden

Maak een .env bestand in je project root:

# Database configuratie
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

Problemen Oplossen

Veelvoorkomende Problemen

1. Code wordt niet opgemaakt: Controleer juiste backticks
2. Syntax highlighting werkt niet: Verifieer taal identificatie
3. Code breekt layout: Gebruik juiste regelbreuken

Backticks Ontsnappen

Als je backticks moet tonen in je code:

Enkele backtick voorbeeld:

• •
  Schrijf: `code`
• •
  Resultaat: code

Drievoudige backticks voorbeeld:

• •
  Schrijf: ```codeblok```
• •
  Resultaat: codeblok

Backticks in inline code:

• •
  Schrijf: ``backtick``
• •
  Resultaat: backtick

Codeblokken zijn essentieel voor technische documentatie. Gebruik ze om je codevoorbeelden duidelijk, leesbaar en goed opgemaakt te maken!

Ten slotte, laten we leren over regelbreuken om je tekstopmaak te perfectioneren.