AsciiDoc: प्रभावी दस्तावेज़ीकरण के लिए सिंटैक्स खोजें और महारत हासिल करें
Publié le 20 June 2025
परिचय
AsciiDoc एक हल्का मार्कअप भाषा है, जो संरचित तकनीकी दस्तावेज़, लेख, किताब या फिर प्रस्तुतियाँ तैयार करने के लिए डिज़ाइन किया गया है। यह अपनी पठनीयता, सिंटैक्टिक समृद्धि और विभिन्न प्रारूप (HTML, PDF, DocBook आदि) उत्पन्न करने की क्षमता से अलग होता है। इस लेख में, हम एससीआइडॉक का मूलभूत सिंटैक्स़ देखेंगे और तेज़ी से शुरू करने के लिए कुछ सुझाव देंगे।
AsciiDoc क्या है?
AsciiDoc दस्तावेज़ विवरण की एक भाषा है, जो Markdown के समान है लेकिन अधिक शक्तिशाली है। यह पाठ, शीर्षक, सूचियों, तालिकाओं, कोड ब्लॉक और कई अन्य चीज़ों को प्रभावी ढंग से संरचित करने की अनुमति देती है। इसकी बहुमुखी प्रतिभा के कारण, यह ओपन‑सोर्स परियोजनाओं के दस्तावेज़ीकरण, किताबों की लेखन और वेब प्रकाशन के लिए एक लोकप्रिय विकल्प है।
AsciiDoc क्यों चुनें ?
-
सहज और पठनीय सिंटैक्स।
-
जटिल संरचनाओं (तालिकाएँ, नोट्स, चेतावनियाँ, आदि) का प्राकृतिक समर्थन।
-
मल्टी-फॉर्मैट उत्पादन (HTML, PDF, ePub, DocBook…)
-
JBake या Antora जैसे स्थिर साइट जनरेटरों के साथ आसान इंटीग्रेशन।
-
उन्नत अनुकूलन विशेषताओं और एक्सटेंशन के साथ
उपयोग केस आरेख (Use Case)
एक उपयोग केस डायग्राम उपयोगकर्ताओं और प्रणाली के बीच मुख्य इंटरैक्शन को प्रस्तुत करने की अनुमति देता है। यहाँ एक दस्तावेज़ीकरण प्रणाली के लिए एक सरल उदाहरण है :
Diagramme Mind Map
माइंड मैप (मानसिक मानचित्र) AsciiDoc से संबंधित अवधारणाओं और उनके संबंधों का पता लगाने के लिए आदर्श है:
प्रवाह आरेख (प्रवाह)
एक फ्लो डायग्राम AsciiDoc दस्तावेज़ की उत्पादन प्रक्रिया का वर्णन करने की अनुमति देता है:
एक AsciiDoc फ़ाइल की बुनियादी संरचना
एक AsciiDoc फ़ाइल सामान्यतः शीर्षक से शुरू होती है, वैकल्पिक विशेषताओं के बाद, फिर संरचित सामग्री। यहाँ एक न्यूनतम उदाहरण दिया गया है :
= Titre Principal
Auteur
2024-09-03
:toc:
:icons: font
Votre contenu commence ici...मूलभूत सिंटैक्स
शीर्षक और अनुभाग
AsciiDoc कई स्तरों के शीर्षकों का समर्थन करता है :
= Titre de niveau 1
== Titre de niveau 2
=== Titre de niveau 3
==== Titre de niveau 4बोल्ड, इटैलिक और मोनोस्पेस में टेक्स्ट
*gras* _italique_ `monospace`सूची बिंदु और क्रमांकित
* Élément 1
* Élément 2
. Premier
. Deuxième
. Troisièmeलिंक और चित्र
Lien standard : https://asciidoc.org[AsciiDoc]
Image : image::images/logo.png[AsciiDoc Logo]कोड ब्लॉकों
[source,python]def hello(): print("नमस्ते AsciiDoc !")
तालिकाएँ
|===
| Colonne 1 | Colonne 2
| Valeur A
| Valeur B
| Valeur C
| Valeur D
|===नोट्स और चेतावनियाँ
AsciiDoc दृश्य सूचना ब्लॉक प्रस्तुत करता है :
NOTE: Ceci est une note importante.
TIP: Conseil utile pour l’utilisateur.
WARNING: Attention à ce point.अट्रिब्यूट और चर का उपयोग
कस्टम विशेषताएँ मान पुनः उपयोग करने या व्यवहार को कॉन्फ़िगर करने की अनुमति देती हैं:
:project-name: AsciiDoc Explorer
Le projet s’appelle {project-name}.सामान्य उपयोग के मामले
-
ओपन सोर्स प्रोजेक्ट दस्तावेज़ीकरण (README, तकनीकी मार्गदर्शिका) - पुस्तकें और ईबुक्स लेखन - स्थिर वेबसाइटों का स्वचालित उत्पादन (JBake, Antora) - तकनीकी प्रस्तुतियाँ
अच्छे अभ्यास
-
संगत शीर्षकों का उपयोग करें और (:toc:) के साथ एक स्वचालित सारणी। - ध्यान आकर्षित करने के लिए मुख्य बिंदुओं पर अधिसूचनाओं को प्राथमिकता दें। अपनी फाइलों को व्यवस्थित रखें ताकि रखरखाव आसान हो। उदाहरण दिखाने के लिए एनोटेटेड कोड ब्लॉक्स का उपयोग करें।
निष्कर्ष
AsciiDoc एक शक्तिशाली और सुलभ उपकरण है जो तकनीकी दस्तावेज़ या संरचित लेख तैयार करने के लिए उपयोगी है। इसकी समृद्ध व्याकरण, बहु-प्रारूप उत्पादन के संयोजन से, यह विकसित करने वालों और मांग वाले लेखकों के लिए एक उत्कृष्ट साथी बन जाता है। अपने अगले प्रोजेक्ट में AsciiDoc आज़माइए और अंतर देखिए!
आगे बढ़ने के लिए
-
आधिकारिक दस्तावेज़: https://asciidoc.org - Asciidoctor : https://asciidoctor.org - JBake और AsciiDoc : https://jbake.org/docs/2.6.4/#asciidoc_support
अपने अनुभव और युक्तियाँ टिप्पणी में साझा करें!