Blok Kode Markdown
Blok kode sangat penting untuk dokumentasi teknis, tutorial, dan konten apa pun yang menyertakan contoh kode. Markdown menyediakan beberapa cara untuk memformat kode, dari kode inline sederhana hingga blok kode lengkap dengan syntax highlighting.
Kode Inline
Untuk potongan kode pendek dalam kalimat, gunakan backtick tunggal:
Gunakan perintah `git status` untuk memeriksa repository Anda.
Fungsi `console.log()` mencetak ke konsol.
Tekan `Ctrl+C` untuk menghentikan proses.
Hasil:
Gunakan perintahgit status
untuk memeriksa repository Anda.
Fungsi console.log()
mencetak ke konsol.
Tekan Ctrl+C
untuk menghentikan proses.
Blok Kode Berpagar
Untuk kode multi-baris, gunakan triple backtick:
```
function greet(name) {
console.log("Hello, " + name + "!");
}
greet("World");
```
Hasil:
function greet(name) {
console.log("Hello, " + name + "!");
}
greet("World");
Syntax Highlighting
Tambahkan nama bahasa setelah backtick pembuka untuk 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
```
Identifier Bahasa Populer
Bahasa | Identifier | Alternatif |
---|---|---|
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 |
Catatan Penting
Blok kode berpagar adalah metode yang direkomendasikan untuk memformat kode dalam Markdown karena menyediakan syntax highlighting yang lebih baik dan lebih didukung luas di berbagai platform.
Praktik Terbaik
1. Selalu Gunakan Syntax Highlighting
❌ Tanpa syntax highlighting:
```
if (user.isLoggedIn) {
showDashboard();
} else {
showLoginForm();
}
```
✅ Dengan syntax highlighting:
```javascript
if (user.isLoggedIn) {
showDashboard();
} else {
showLoginForm();
}
```
2. Jaga Contoh Kode Tetap Fokus
❌ Terlalu banyak kode yang tidak relevan:
```javascript
// Lots of setup code...
const express = require('express');
const app = express();
const PORT = 3000;
// ... more setup ...
// The actual example (buried in setup)
app.get('/api/users', (req, res) => {
res.json({ users: [] });
});
// ... more boilerplate ...
```
✅ Fokus pada bagian penting:
```javascript
// Create a simple API endpoint
app.get('/api/users', (req, res) => {
res.json({ users: [] });
});
```
Kasus Penggunaan Umum
Dokumentasi API
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"
}
File Konfigurasi
Buat file.env
di root proyek Anda:
# Database configuration
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
Pemecahan Masalah
Masalah Umum
- Kode tidak terformat: Periksa backtick yang tepat
- Syntax highlighting tidak bekerja: Verifikasi identifier bahasa
- Kode merusak layout: Gunakan line break yang tepat
Escape Backtick
Jika Anda perlu menampilkan backtick dalam kode Anda:Contoh backtick tunggal:
- •Tulis: `code`
- •Hasil:
code
- •Tulis: ```code block```
- •Hasil:
code block
- •Tulis: ``backtick``
- •Hasil:
backtick
Terakhir, mari belajar tentang line break untuk menyempurnakan pemformatan teks Anda.