Word to Markdown for GitBook: Word Docs से प्रलेखन प्रकाशित करें

GitBook Markdown का उपयोग करके प्रलेखन साइट, API गाइड और ज्ञान आधार बनाने के लिए एक लोकप्रिय मंच है। यदि आपके प्रलेखन मसौदे Word में रहते हैं, तो उन्हें GitBook-संगत Markdown में परिवर्तित करना एक सरल प्रक्रिया है. यह मार्गदर्शिका पूर्ण __पी_बी__ से __पी_ए__ कार्यप्रवाह।

दस्तावेज के लिए GitBook क्यों?

GitBook Markdown फ़ाइलों को एक पॉलिश, खोज योग्य प्रलेखन साइट में बदल देता है:

एक स्वच्छ, पेशेवर डिफ़ॉल्ट थीम
पूर्ण-पाठ खोज
आपकी फ़ाइल संरचना से उत्पन्न नेविगेशन साइडबार
GitHub संस्करण-नियंत्रित डॉक्स के लिए सिंक्रनाइज़ेशन
कस्टम डोमेन

Word में लिखी गई सामग्री GitBook के पृष्ठ मॉडल में अच्छी तरह से मेल खाती है जब इसे Markdown में परिवर्तित कर दिया जाता है.

Word दस्तावेजों का रूपांतरण

के साथ शुरू WordToMD:

अपने .docx प्रलेखन मसौदा को कन्वर्टर पर खींचें
Markdown आउटपुट की समीक्षा करें शीर्षकों, तालिकाओं और कोड अनुभागों की जाँच करें
.md फ़ाइल डाउनलोड करें

आउटपुट मानक Markdown है जिसे GitBook सीधे स्वीकार करता है.

GitBook फ़ाइल संरचना

GitBook एक के आसपास सामग्री को व्यवस्थित करता है SUMMARY.md फ़ाइल जो नेविगेशन संरचना को परिभाषित करती है:

# Table of Contents

* [Introduction](README.md)
* [Getting Started](getting-started/README.md)
  * [Installation](getting-started/installation.md)
  * [Configuration](getting-started/configuration.md)
* [API Reference](api/README.md)
  * [Authentication](api/authentication.md)

SUMMARY.md में प्रत्येक बुलेट आपके GitBook साइडबार में एक पृष्ठ बन जाती है. अपने Word दस्तावेजों को परिवर्तित करने के बाद, उन्हें इस संरचना में व्यवस्थित करें.

__पी_ए__ में मुख्य विषय

GitBook (लेगेसी संस्करण) YAML फ्रंटमैटर का उपयोग नहीं करता है पृष्ठ शीर्षक पहले H1 शीर्षक से आते हैं. GitBook का नया संस्करण (GitBook.com) कुछ फ्रंटमैटर को स्वीकार करता है, लेकिन सुरक्षित दृष्टिकोण पहले का उपयोग करना है # Heading पृष्ठ शीर्षक के रूप मेंः

# Authentication Guide

This section describes how to authenticate with the API.

## Overview

...

प्रभाग संरचना

GitBook H2 और H3 शीर्षकों से पृष्ठ-स्तर की सामग्री तालिका उत्पन्न करता है. अपने पदानुक्रम को साफ रखें:

H1 पृष्ठ शीर्षक (प्रत्येक फ़ाइल में एक)
H2 प्रमुख अनुभाग (पृष्ठ TOC में दिखाई देते हैं)
H3 उपधाराएँ

देखें Markdown शीर्षक गाइड सर्वोत्तम प्रथाओं के शीर्षक के लिए।

GitBook में तालिकाएँ

GitBook स्टाइलिंग के साथ GFM तालिकाओं को प्रस्तुत करता है. आपके Word दस्तावेज़ से तालिकाओं को सही रूप से परिवर्तित करें WordToMD:

| Endpoint | Method | Description |
|---|---|---|
| `/auth/login` | POST | Authenticate user |
| `/auth/logout` | POST | End session |
| `/users/{id}` | GET | Get user profile |

जटिल तालिका परिदृश्यों के लिए, देखें Markdown तालिकाएँ: एक पूर्ण मार्गदर्शिका.

कोड ब्लॉक

GitBook वाक्यविन्यास हाइलाइटिंग के साथ बाड़ लगाये गए कोड ब्लॉक को प्रस्तुत करता है. के साथ परिवर्तित करने के बाद WordToMD, कोड नमूनों को ठीक से प्रारूपित करें:

```bash
npm install -g gitbook-cli
gitbook init my-docs
```

GitBook में कॉलआउट के लिए एक विशेष Hint ब्लॉक प्रकार भी है:

{% hint style="info" %}
This is an information callout.
{% endhint %}

{% hint style="warning" %}
This is a warning callout.
{% endhint %}

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

GitHub सिंक्रनाइज़ कार्यप्रवाह

GitBook GitHub रिपॉजिटरी के साथ सिंक्रनाइज़ेशन का समर्थन करता है:

GitHub रेपो बनाएं और अपनी परिवर्तित .md फ़ाइलें जोड़ें
GitBooks सेटिंग में GitBook को रेपो से कनेक्ट करें
GitBook स्वचालित रूप से Markdown फ़ाइलों से बनाता है और प्रकाशित करता है
GitBook में संपादन GitHub में वापस सिंक, और इसके विपरीत

यह आपको अपने डॉक्स के लिए संस्करण नियंत्रण देता है और आपकी टीम को GitHub PRs के माध्यम से या सीधे GitBook के संपादक में सहयोग करने देता है.

GitHub Markdown विशिष्टता के लिए, देखें __पी_सी__ से __पी_बी__ __पी_ए__.

चित्र

अपने Word दस्तावेजों से छवियों का निर्यात करें (जैसे सहेजें → वेब पेज एक फ़ोल्डर में छवियों को सहेजता है). GitBook में GitHub सिंक्रनाइज़ेशन के साथ, छवियों को एक assets/ or images/ निर्देशिका और उनका संदर्भः

![Architecture Diagram](assets/architecture.png)

GitBook के वेब एडिटर में, आप पृष्ठों को संपादित करते समय सीधे चित्र अपलोड कर सकते हैं.

एक पूर्ण प्रलेखन सेट को स्थानांतरित करना

Word से GitBook में बड़े दस्तावेज़ीकरण के लिए माइग्रेशनः

Word दस्तावेजों का ऑडिट करें पृष्ठों, अनुभागों और पदानुक्रम की पहचान करें
SUMMARY.md संरचना की योजना बनाएं परिवर्तित करने से पहले
फ़ाइलें परिवर्तित करें with WordToMD (या बैच परिवर्तक बड़ी मात्रा के लिए)
SUMMARY.md बनाना आपके नियोजित संरचना के अनुरूप
प्रत्येक पृष्ठ की समीक्षा करें शीर्षक पदानुक्रम, तालिका स्वरूपण और कोड ब्लॉक के लिए
प्रकाशन GitBooks आयात या GitHub सिंक्रनाइज़ेशन के माध्यम से

FAQ

Markdown किस स्वाद का उपयोग GitBook करता है? GitBook मानक Markdown (CommonMark) प्लस अपने स्वयं के एक्सटेंशन (संकेतक ब्लॉक, टैब, एम्बेड ब्लॉक) का उपयोग करता है. WordToMD से Markdown आउटपुट संगत है.

क्या मैं .docx को सीधे GitBook में आयात कर सकता हूँ? GitBook.com की आयात सुविधा Word दस्तावेजों को स्वीकार करती है, लेकिन आउटपुट अक्सर Markdown से गुजरने की तुलना में कम गुणवत्ता वाला होता है। जटिल दस्तावेजों के लिए दो-चरण दृष्टिकोण (Word → Markdown → GitBook) बेहतर परिणाम देता है।

मैं क्रॉस-दस्तावेज़ लिंक को कैसे संभालूं? GitBook में GitHub सिंक्रनाइज़ेशन के साथ, सापेक्ष Markdown लिंक का उपयोग करें: [See Authentication](../api/authentication.md). GitBook resolves these to proper page links.

मेरे प्रलेखन में 50+ Word फाइलें हैं. क्या कोई तेज कार्यप्रवाह है? देखें बैच Word को Markdown में परिवर्तित करें रूपांतरण चरण को स्वचालित करने के लिए, फिर फ़ाइल संरचना से SUMMARY.md उत्पन्न करने के लिए एक स्क्रिप्ट लिखें.

निष्कर्ष

परिवर्तित करना __पी_सी__ से __पी_बी__ __पी_ए__ एक स्वच्छ कार्यप्रवाह है: WordToMD दस्तावेज़ रूपांतरण संभालता है, और GitBooks GitHub सिंक या प्रत्यक्ष आयात प्रकाशन संभालता है. वर्ड में मानक शीर्षक शैलियों का उपयोग करें, अपने तालिकाओं को सरल रखें, और आपके पास एक पेशेवर प्रलेखन साइट जल्दी चल रही होगी।