Word से GitHub Markdown: GitHub READMEs और Issues के लिए दस्तावेज़ स्वरूपित करें

GitHub एक Markdown बोली का उपयोग करता है जिसे कहा जाता है GitHub स्वादित Markdown (GFM). It’s mostly standard Markdown with a few extras — fenced code blocks with syntax highlighting, task lists, tables, and automatic link detection. If you’re converting a Word document into a GitHub README or wiki page, here’s what you need to know.

GitHub स्वाद वाला Markdown क्या है?

GFM GitHub का CommonMark विस्तार है। Word से परिवर्तित करते समय जो जोड़ सबसे अधिक मायने रखते हैं वे हैंः

वेल्डेड कोड ब्लॉक भाषा पहचानकों के साथ (```python)
तालिकाएँ पाइप वाक्यविन्यास का उपयोग करना
कार्य सूची using - [ ] and - [x]
प्रहार using ~~text~~
ऑटोलिंक्स रिक्त URL क्लिक करने योग्य हो जाते हैं

अपने Word दस्तावेज़ को परिवर्तित करें WordToMD और आपको डिफ़ॉल्ट रूप से GFM संगत आउटपुट मिलेगा.

Word शैली → GFM तत्व

Word तत्व	GFM आउटपुट
शीर्षक 1	`# H1`
शीर्षक 2	`## H2`
बोल्ड	`bold`
इटालिक	`italic`
तालिका	पाइप टेबल
बुलेट सूची	`- item`
क्रमांकित सूची	`1. item`
हाइपरलिंक	`[text](url)`
मोनोस्पेस फ़ॉन्ट	`code`
प्रहार	`~~text~~`

GitHub-परिवर्तन के बाद जोड़ने के लिए विशिष्ट विशेषताएं

कार्य सूची

Word में कोई मूल कार्य सूची तत्व नहीं है. यदि आपके Word doc में चेकबॉक्स हैं, तो वे सादे पाठ में परिवर्तित हो जाते हैं. रूपांतरण के बाद, उन्हें GFM कार्य सूची के रूप में स्वरूपित करें:

- [x] Completed item
- [ ] Pending item
- [ ] Another pending item

ये GitHub Issues, Pull Requests, और project README फ़ाइलों में इंटरैक्टिव चेकबॉक्स के रूप में प्रस्तुत करते हैं.

वाक्यविन्यास हाइलाइटिंग के साथ बाड़ लगाये गए कोड ब्लॉक

Word से मोनोस्पेस टेक्स्ट इनलाइन कोड में परिवर्तित होता है. GitHub पर बहु-पंक्ति कोड ब्लॉकों के लिए, भाषा पहचानकर्ता के साथ फ़ेंस किए गए वाक्यविन्यास का उपयोग करें:

```javascript
function greet(name) {
  return `Hello, ${name}!`;
}


GitHub supports dozens of languages. See [Markdown Code Blocks Guide](/blog/markdown-code-blocks-guide) for the full language list and syntax rules.

### Alerts (GitHub-Specific Callouts)

GitHub renders special blockquote syntax as colored callout boxes:

```markdown
> [!NOTE]
> This is a note callout.

> [!WARNING]
> This is a warning.

> [!TIP]
> This is a helpful tip.

यदि आपके वर्ड दस्तावेज़ में कॉलआउट बॉक्स या हाइलाइट किए गए नोट हैं, तो उन्हें प्रारंभिक रूपांतरण के बाद इस जीएफएम अलर्ट सिंटैक्स में परिवर्तित करें.

Word दस्तावेज़ से README को संरचित करना

एक विशिष्ट सॉफ़्टवेयर README इस संरचना का अनुसरण करता है:

# Project Name

Short description.

## Installation

## Usage

## Configuration

## Contributing

## License

यदि आपका Word दस्तावेज़ एक परियोजना विनिर्देश या प्रलेखन प्रारूप है, तो इसके अनुभागों को इन README शीर्षकों में मैप करें. उपयोग WordToMD कच्ची सामग्री को परिवर्तित करने के लिए, फिर पुनर्गठित करें और GitHub-विशिष्ट तत्व जोड़ें।

GitHub Markdown में तालिकाएँ

Word तालिकाएँ सीधे GFM पाइप तालिकाओं में परिवर्तित होती हैं। यहाँ एक परिवर्तित तालिका की तरह दिखता है:

| Feature | Status | Notes |
|---|---|---|
| Authentication | ✅ Done | JWT-based |
| File upload | 🚧 In progress | S3 target |
| API docs | ❌ Pending | — |

GitHub स्तंभ संरेखण का भी समर्थन करता है:

| Left | Center | Right |
|:---|:---:|---:|
| text | text | text |

Markdown तालिकाओं के बारे में सब कुछ, देखें Markdown तालिकाएँ: एक पूर्ण मार्गदर्शिका.

GitHub रिपॉजिटरी में छवियाँ

GitHub रेपो में सापेक्ष पथों से छवियों को प्रस्तुत करता हैः

![Architecture diagram](docs/images/architecture.png)

यदि Word दस्तावेज़ में समर्थित चित्र हैं, तो डाउनलोड करें __पी_ए__ + छवियाँ __पी_बी__, पैक की गई छवि फ़ाइलों को स्थानांतरित करें docs/images/, और सापेक्ष पथों को अद्यतन करें यदि आपका रिपॉजिटरी एक अलग फ़ोल्डर संरचना का उपयोग करता है.

GitHub.com-होस्ट की गई छवियों के लिए, आप पूर्ण URL का भी उपयोग कर सकते हैंः

![Screenshot](https://github.com/user/repo/raw/main/screenshot.png)

GitHub विकि पृष्ठ

GitHub विकी पूर्ण GFM विनिर्देश का समर्थन करते हैं. रूपांतरण कार्यप्रवाह README के लिए समान है:

अपने Word दस्तावेज़ को परिवर्तित करें WordToMD
GFM-विशिष्ट स्वरूपण जोड़ें (कार्य सूची, कोड बाड़, अलर्ट)
नया विकी पृष्ठ बनाएं और Markdown पेस्ट करें

हेडिंग आईडी और एंकर लिंक

GitHub शीर्षक पाठ से स्वचालित रूप से एंकर आईडी उत्पन्न करता है. शीर्षक ## Installation आईडी प्राप्त करता है #installation. You can link to it from elsewhere in the same document:

See the [Installation section](#installation) below.

यह सामग्री सारणी के साथ लंबे README के लिए उपयोगी है। रूपांतरण के बाद, शीर्ष पर एक TOC जोड़ेंः

## Table of Contents
- [Installation](#installation)
- [Usage](#usage)
- [Contributing](#contributing)

FAQ

क्या GitHub HTML को Markdown में प्रस्तुत करता है? GitHub Markdown में कुछ HTML टैग की अनुमति देता है लेकिन अधिकांश स्टाइलिंग गुणों को हटा देता है. सर्वोत्तम परिणामों के लिए Markdown वाक्यविन्यास का पालन करें.

मेरी मेज में बहुत से स्तंभ हैं और मोबाइल पर संकीर्ण दिखता है। मुझे क्या करना चाहिए? बड़े तालिकाओं को छोटे केंद्रित तालिकाओं में तोड़ने पर विचार करें, या HTML का उपयोग करें <details> फोल्डेबल अनुभागों के लिए टैग।

क्या मैं Word का उपयोग GitHub Issues लिखने के लिए कर सकता हूँ? हाँ! अपने Word doc को Markdown में परिवर्तित करें WordToMD और आउटपुट को सीधे GitHub Issue या Pull Request विवरण में पेस्ट करें.

मैं एक पूरे Word दस्तावेज़ सेट को GitHub विकी में कैसे परिवर्तित करूं? प्रत्येक Word फ़ाइल को व्यक्तिगत रूप से परिवर्तित करें और प्रति दस्तावेज़ एक विकी पृष्ठ बनाएं. देखें बैच Word को Markdown में परिवर्तित करें Pandoc के साथ इसे स्क्रिप्ट करने के लिए।

निष्कर्ष

Word को परिवर्तित करना __पी_बी__ __पी_ए__ सरल है उपयोग WordToMD आधार Markdown प्राप्त करने के लिए, फिर GFM-विशिष्ट सुविधाओं जैसे कार्य सूचियों, कोड बाड़, और कॉलआउट अलर्ट पर परत। अपने Word दस्तावेज़ में एक साफ संरचना के साथ (निर्मित शीर्षक शैलियों, उचित तालिकाओं), रूपांतरण आउटपुट लगभग GitHub पर धक्का देने के लिए तैयार हो जाएगा.