Markdown Code Blocks

Kodeblokker er essensielle for teknisk dokumentasjon, veiledninger og alt innhold som inkluderer kodeeksempler. Markdown tilbyr flere måter å formatere kode på, fra enkle innebygde kodebiter til fullstendige kodeblokker med syntaksutheving.

Innebygd kode

For korte kodebiter innenfor setninger, bruk enkle backticks:

Bruk `git status` kommandoen for å sjekke repository-et ditt.
`console.log()` funksjonen skriver ut til konsollen.
Trykk `Ctrl+C` for å stoppe prosessen.

Resultat:

Bruk git status kommandoen for å sjekke repository-et ditt. console.log() funksjonen skriver ut til konsollen. Trykk Ctrl+C for å stoppe prosessen.

Avgrensede kodeblokker

For flerlinjet kode, bruk tre backticks:

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

greet("World");
```

Resultat:

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

greet("World");

Syntaksutheving

Legg til språknavnet etter åpnings-backticks for syntaksutheving:

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 språkidentifikatorer

Språk	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

Viktige merknader

Avgrensede kodeblokker er den foretrukne metoden for å formatere kode i Markdown da de gir bedre syntaksutheving og er mer utbredt støttet på tvers av forskjellige plattformer.

Beste praksis

1. Bruk alltid syntaksutheving

❌ Ingen syntaksutheving:

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

✅ Med syntaksutheving:

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

2. Hold kodeeksempler fokuserte

❌ For mye irrelevant kode:

```javascript
// Masse oppsettskode...
const express = require('express');
const app = express();
const PORT = 3000;

// ... mer oppsett ...

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

// ... mer boilerplate ...
```

✅ Fokusert på den viktige delen:

```javascript
// Lag et enkelt API-endepunkt
app.get('/api/users', (req, res) => {
  res.json({ users: [] });
});
```

Vanlige bruksområder

API-dokumentasjon

Forespørsel:

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

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

Respons:

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

Konfigurasjonsfiler

Lag en .env fil i prosjektroten din:

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

# API-nøkler
API_KEY=your_api_key_here
SECRET_KEY=your_secret_key_here

Feilsøking

Vanlige problemer

1. Kode formateres ikke: Sjekk for riktige backticks
2. Syntaksutheving fungerer ikke: Bekreft språkidentifikator
3. Kode ødelegger layout: Bruk riktige linjeskift

Escaping av backticks

Hvis du trenger å vise backticks i koden din:

Enkelt backtick eksempel:

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

Tre backticks eksempel:

• •
  Skriv: ```kodeblokk```
• •
  Resultat: kodeblokk

Backticks i innebygd kode:

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

Kodeblokker er essensielle for teknisk dokumentasjon. Bruk dem for å gjøre kodeeksemplene dine klare, lesbare og riktig formaterte!

Til slutt, la oss lære om linjeskift for å perfeksjonere tekstformateringen din.