মার্কডাউন কোড সিনট্যাক্স
কোড হল টেকনিক্যাল ডকুমেন্টেশনে একটি গুরুত্বপূর্ণ উপাদান। মার্কডাউন কোড প্রদর্শনের জন্য একাধিক উপায় প্রদান করে, যার মধ্যে ইনলাইন কোড এবং কোড ব্লক রয়েছে।
মার্কডাউন ইনলাইন কোড
মার্কডাউন বেসিক সিনট্যাক্স
কোড ঘিরতে ব্যাকটিক ` ব্যবহার করুন:
এটি `ইনলাইন কোড`-এর একটি উদাহরণ।
তথ্য আউটপুট করতে `console.log()` ফাংশন ব্যবহার করুন।রেন্ডার্ড আউটপুট:
এটি ইনলাইন কোড-এর একটি উদাহরণ। তথ্য আউটপুট করতে console.log() ফাংশন ব্যবহার করুন।
ব্যাকটিক সম্বলিত মার্কডাউন কোড
যখন কোডে নিজেই ব্যাকটিক থাকে, তখন ডাবল ব্যাকটিক ব্যবহার করুন:
`` `console.log()` ফাংশন ব্যবহার করুন ``রেন্ডার্ড আউটপুট:
`console.log()` ফাংশন ব্যবহার করুন
একাধিক ব্যাকটিক হ্যান্ডলিং
```একাধিক ব্যাকটিক সহ কোড `` ` এখানে```রেন্ডার্ড আউটপুট:
একাধিক ব্যাকটিক সহ কোড `` ` এখানে
মার্কডাউন কোড ব্লক
মার্কডাউন ইনডেন্টেড কোড ব্লক
ইনডেন্ট করতে 4 স্পেস অথবা 1 ট্যাব ব্যবহার করুন:
function hello() {
console.log("Hello, World!");
}রেন্ডার্ড আউটপুট:
function hello() {
console.log("Hello, World!");
}
মার্কডাউন ফেন্সড কোড ব্লক
তিনটি ব্যাকটিক ``` অথবা টিল্ড ~~~ ব্যবহার করে কোড ঘিরে ফেলুন:
```
function hello() {
console.log("Hello, World!");
}
```রেন্ডার্ড আউটপুট:
function hello() {
console.log("Hello, World!");
}প্রোগ্রামিং ল্যাঙ্গুয়েজ নির্দিষ্ট করা
সিনট্যাক্স হাইলাইটিং সক্ষম করতে খোলার ```-এর পরে ল্যাঙ্গুয়েজের নাম উল্লেখ করুন:
```javascript
function hello(name) {
console.log(`Hello, ${name}!`);
}
```রেন্ডার্ড আউটপুট:
function hello(name) {
console.log(`Hello, ${name}!`);
}সাধারণ প্রোগ্রামিং ল্যাঙ্গুয়েজ উদাহরণ
JavaScript
```javascript
// অ্যাসিন্ক ফাংশনের উদাহরণ
async function fetchData(url) {
try {
const response = await fetch(url);
const data = await response.json();
return data;
} catch (error) {
console.error('Error:', error);
}
}
```রেন্ডার্ড আউটপুট:
// অ্যাসিন্ক ফাংশনের উদাহরণ
async function fetchData(url) {
try {
const response = await fetch(url);
const data = await response.json();
return data;
} catch (error) {
console.error('Error:', error);
}
}Python
```python
# ক্লাস ডেফিনিশনের উদাহরণ
class Calculator:
def __init__(self):
self.result = 0
def add(self, x, y):
return x + y
def multiply(self, x, y):
return x * y
# ব্যবহারের উদাহরণ
calc = Calculator()
print(calc.add(5, 3))
```রেন্ডার্ড আউটপুট:
# ক্লাস ডেফিনিশনের উদাহরণ
class Calculator:
def __init__(self):
self.result = 0
def add(self, x, y):
return x + y
def multiply(self, x, y):
return x * y
# ব্যবহারের উদাহরণ
calc = Calculator()
print(calc.add(5, 3))HTML
```html
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title>স্যাম্পল পেজ</title>
</head>
<body>
<h1>মার্কডাউনে স্বাগতম</h1>
<p>এটি একটি স্যাম্পল প্যারাগ্রাফ।</p>
</body>
</html>
```রেন্ডার্ড আউটপুট:
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title>স্যাম্পল পেজ</title>
</head>
<body>
<h1>মার্কডাউনে স্বাগতম</h1>
<p>এটি একটি স্যাম্পল প্যারাগ্রাফ।</p>
</body>
</html>CSS
```css
/* রেসপন্সিভ লেআউট উদাহরণ */
.container {
max-width: 1200px;
margin: 0 auto;
padding: 0 20px;
}
@media (max-width: 768px) {
.container {
padding: 0 10px;
}
}
.button {
background-color: #007bff;
color: white;
border: none;
padding: 10px 20px;
border-radius: 4px;
cursor: pointer;
}
.button:hover {
background-color: #0056b3;
}
```রেন্ডার্ড আউটপুট:
/* রেসপন্সিভ লেআউট উদাহরণ */
.container {
max-width: 1200px;
margin: 0 auto;
padding: 0 20px;
}
@media (max-width: 768px) {
.container {
padding: 0 10px;
}
}
.button {
background-color: #007bff;
color: white;
border: none;
padding: 10px 20px;
border-radius: 4px;
cursor: pointer;
}
.button:hover {
background-color: #0056b3;
}Bash/Shell
```bash
#!/bin/bash
# স্ক্রিপ্ট উদাহরণ: ব্যাচ প্রসেস ফাইল
for file in *.txt; do
if [ -f "$file" ]; then
echo "Processing $file"
cp "$file" "backup_$file"
fi
done
# ফাংশন ডেফিনিশন
function check_dependencies() {
command -v git >/dev/null 2>&1 || {
echo "Git প্রয়োজন কিন্তু ইনস্টল করা নেই।"
exit 1
}
}
check_dependencies
echo "সমস্ত ডিপেন্ডেন্সি পূরণ করা হয়েছে।"
```রেন্ডার্ড আউটপুট:
#!/bin/bash
# স্ক্রিপ্ট উদাহরণ: ব্যাচ প্রসেস ফাইল
for file in *.txt; do
if [ -f "$file" ]; then
echo "Processing $file"
cp "$file" "backup_$file"
fi
done
# ফাংশন ডেফিনিশন
function check_dependencies() {
command -v git >/dev/null 2>&1 || {
echo "Git প্রয়োজন কিন্তু ইনস্টল করা নেই।"
exit 1
}
}
check_dependencies
echo "সমস্ত ডিপেন্ডেন্সি পূরণ করা হয়েছে।"JSON
```json
{
"name": "markdown-tutorial",
"version": "1.0.0",
"description": "মার্কডাউন বাংলা টিউটোরিয়াল",
"main": "index.js",
"scripts": {
"dev": "vitepress dev docs",
"build": "vitepress build docs",
"preview": "vitepress preview docs"
},
"dependencies": {
"vitepress": "^1.0.0"
},
"author": "আপনার নাম",
"license": "MIT"
}
```রেন্ডার্ড আউটপুট:
{
"name": "markdown-tutorial",
"version": "1.0.0",
"description": "মার্কডাউন বাংলা টিউটোরিয়াল",
"main": "index.js",
"scripts": {
"dev": "vitepress dev docs",
"build": "vitepress build docs",
"preview": "vitepress preview docs"
},
"dependencies": {
"vitepress": "^1.0.0"
},
"author": "আপনার নাম",
"license": "MIT"
}অ্যাডভান্সড কোড ব্লক বৈশিষ্ট্য
লাইন নাম্বার দেখানো
কিছু মার্কডাউন প্রসেসর লাইন নাম্বার দেখাতে সমর্থন করে:
```javascript {1}
// এটি প্রথম লাইন
function example() {
console.log("Hello");
}
```লাইন হাইলাইটিং
নির্দিষ্ট লাইন হাইলাইট করুন:
```javascript {2-3}
function example() {
console.log("এই লাইনটি হাইলাইট করা হয়েছে"); // হাইলাইট করা
return true; // হাইলাইট করা
}
```ফাইলনেম দেখানো
কোড ফাইলনেম প্রদর্শন করুন:
```javascript title="app.js"
const express = require('express');
const app = express();
app.get('/', (req, res) => {
res.send('Hello World!');
});
```সাধারণ ত্রুটি এবং সমাধান
1. ব্যাকটিকের সংখ্যা মismatched
❌ ভুল:
```javascript
function hello() {
console.log("Hello");
}
`` ← ব্যাকটিকের সংখ্যা মismatched
✅ সঠিক:
```javascript
function hello() {
console.log("Hello");
}
```2. ইনডেন্টেশন সামঞ্জস্যহীন
❌ ভুল: ইনডেন্টেড কোড ব্লক
প্রথম লাইন (4 স্পেস)
দ্বিতীয় লাইন (2 স্পেস) ← ইনডেন্টেশন সামঞ্জস্যহীন
✅ সঠিক: ইনডেন্টেড কোড ব্লক
প্রথম লাইন (4 স্পেস)
দ্বিতীয় লাইন (4 স্পেস)3. ভুল ল্যাঙ্গুয়েজ নাম
❌ ভুল:
```js ← javascript হওয়া উচিত
function hello() {}
```
✅ সঠিক:
```javascript
function hello() {}
```সমর্থিত ল্যাঙ্গুয়েজ তালিকা
সাধারণ ল্যাঙ্গুয়েজ আইডেন্টিফায়ার:
| ল্যাঙ্গুয়েজ | আইডেন্টিফায়ার | উদাহরণ |
|---|---|---|
| JavaScript | javascript, js | function(){} |
| Python | python, py | def function(): |
| Java | java | public class{} |
| C++ | cpp, c++ | #include <iostream> |
| C# | csharp, cs | public class{} |
| Go | go | func main(){} |
| Rust | rust, rs | fn main(){} |
| TypeScript | typescript, ts | interface{} |
| PHP | php | <?php |
| Ruby | ruby, rb | def method |
| SQL | sql | SELECT * FROM |
| HTML | html | <div></div> |
| CSS | css | .class{} |
| XML | xml | <root></root> |
| YAML | yaml, yml | key: value |
| Markdown | markdown, md | # Title |
| Bash | bash, sh | #!/bin/bash |
| PowerShell | powershell, ps1 | Get-Process |
| Dockerfile | dockerfile | FROM ubuntu |
সেরা অনুশীলন
1. উপযুক্ত কোড ফরম্যাট নির্বাচন করুন
✅ সুপারিশকৃত: ছোট কোডের জন্য ইনলাইন ফরম্যাট ব্যবহার করুন
অ্যারে প্রসেস করতে `Array.map()` মেথড ব্যবহার করুন।
✅ সুপারিশকৃত: দীর্ঘ কোডের জন্য কোড ব্লক ব্যবহার করুন
function processArray(arr) {
return arr.map(item => item * 2);
}2. উপযুক্ত মন্তব্য যোগ করুন
✅ সুপারিশকৃত: ব্যাখ্যামূলক মন্তব্য অন্তর্ভুক্ত করুন
```javascript
// অ্যারে উপাদানের গড় গণনা করুন
function calculateAverage(numbers) {
const sum = numbers.reduce((acc, num) => acc + num, 0);
return sum / numbers.length;
}
```3. সঠিক ল্যাঙ্গুয়েজ আইডেন্টিফায়ার ব্যবহার করুন
✅ সুপারিশকৃত: স্পষ্ট ল্যাঙ্গুয়েজ আইডেন্টিফায়ার
```typescript
interface User {
id: number;
name: string;
}
```
❌ সুপারিশকৃত নয়: অস্পষ্ট ল্যাঙ্গুয়েজ আইডেন্টিফায়ার
```text
interface User {
id: number;
name: string;
}
```4. কোড সংক্ষিপ্ত রাখুন
✅ সুপারিশকৃত: মূল লজিক দেখান
```javascript
// ব্যবহারকারী প্রমাণীকরণ
function authenticate(token) {
return validateToken(token);
}
```
❌ সুপারিশকৃত নয়: খুব বেশি অপ্রাসঙ্গিক বিবরণ
```javascript
// এটি একটি দীর্ঘ কোড যার অনেক অপ্রাসঙ্গিক বিবরণ আছে...
```HTML আউটপুট
মার্কডাউন কোড HTML-এ রূপান্তরিত হয়:
`ইনলাইন কোড`রূপান্তরিত হয়:
<code>ইনলাইন কোড</code>কোড ব্লক:
```javascript
function hello() {}
```রূপান্তরিত হয়:
<pre><code class="language-javascript">
function hello() {}
</code></pre>ব্যবহারিক উদাহরণ
API ডকুমেন্টেশন
## ব্যবহারকারী লগইন
`/api/login`-এ একটি POST অনুরোধ পাঠান:
```bash
curl -X POST https://api.example.com/login \
-H "Content-Type: application/json" \
-d '{
"email": "user@example.com",
"password": "password123"
}'
```
স্যাম্পল রেসপন্স:
```json
{
"success": true,
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
"user": {
"id": 1,
"email": "user@example.com",
"name": "ঝাং সান"
}
}
```কনফিগারেশন ফাইল উদাহরণ
## প্রকল্প কনফিগারেশন
একটি `config.json` ফাইল তৈরি করুন:
```json
{
"database": {
"host": "localhost",
"port": 5432,
"name": "myapp"
},
"server": {
"port": 3000,
"host": "0.0.0.0"
}
}
```
`package.json` স্ক্রিপ্ট আপডেট করুন:
```json
{
"scripts": {
"start": "node server.js",
"dev": "nodemon server.js",
"test": "jest"
}
}
```ইনস্টলেশন গাইড
## এনভায়রনমেন্ট সেটআপ
1. Node.js ইনস্টল করুন:
```bash
# macOS (Homebrew ব্যবহার করে)
brew install node
# Ubuntu/Debian
sudo apt update
sudo apt install nodejs npm
# Windows (Chocolatey ব্যবহার করে)
choco install nodejs
```
2. ইনস্টলেশন যাচাই করুন:
```bash
node --version
npm --version
```
3. প্রকল্প ইনিশিয়ালাইজ করুন:
```bash
mkdir my-project
cd my-project
npm init -y
```সম্পর্কিত সিনট্যাক্স
- ফেন্সড কোড ব্লক - এক্সটেন্ডেড কোড বৈশিষ্ট্য
- এমফ্যাসিস সিনট্যাক্স - টেক্সট ফরম্যাটিং
- লিঙ্ক সিনট্যাক্স - লিঙ্ক তৈরি
- এস্কেপিং ক্যারেক্টার - বিশেষ ক্যারেক্টার হ্যান্ডলিং
অনুশীলন
নিম্নলিখিতগুলি তৈরি করার চেষ্টা করুন:
- বিভিন্ন প্রোগ্রামিং ল্যাঙ্গুয়েজে কোড উদাহরণের একটি সংগ্রহ
- অনুরোধ এবং রেসপন্স কোড সহ একটি API ব্যবহারের টিউটোরিয়াল
- বিভিন্ন সিস্টেমের জন্য কমান্ড-লাইন নির্দেশাবলী সহ একটি ইনস্টলেশন গাইড
- বিস্তারিত মন্তব্য সহ একটি কনফিগারেশন ফাইল টেমপ্লেট