Guidedog¶
एक बार लिखें। अच्छी तरह समझाएँ। वेब पर और काग़ज़ पर प्रकाशित करें।
Guidedog एक ही reStructuredText या Markdown फ़ाइलों से दस्तावेज़ वेबसाइट और PDF पुस्तक बनाता है। आप पाठ एक बार लिखते हैं; दोनों संस्करणों को Guidedog एक जैसा रखता है।
एक सादी टेक्स्ट फ़ाइल अंदर जाती है। Guidedog उससे एक वेब पेज और पुस्तक का एक पृष्ठ बनाता है।
यह क्या करता है¶
- वेबसाइट। नेविगेशन, खोज, हाइलाइट किए गए कोड और हल्की व गहरी थीम वाले पेज, Jinja टेम्पलेट से, जिन्हें आप जितना चाहें बदल सकते हैं।
- PDF पुस्तक। अध्याय, क्रॉस-रेफ़रेंस, चित्र, तालिकाएँ, फ़ुटनोट और अनुक्रमणिका, जिन्हें Typst हर भाषा के नियमों के अनुसार टाइपसेट करता है।
- reStructuredText और Markdown। डायरेक्टिव, रोल, toctree और क्रॉस-रेफ़रेंस वैसे ही काम करते हैं जैसे Sphinx के उपयोगकर्ता उम्मीद करते हैं, और MyST Markdown भी साथ में इस्तेमाल हो सकता है।
- अनुवाद। Gettext कैटलॉग किसी प्रोजेक्ट को दूसरी भाषाओं में ले जाते हैं। चीनी, जापानी, कोरियाई और हिन्दी पाठ स्क्रीन पर और काग़ज़ पर सही ढंग से सजता है।
- आरेख, गणित और API पेज। Graphviz आरेख, LaTeX समीकरण, और सोर्स कोड से पढ़ा गया Odin API संदर्भ।
- साफ़ त्रुटियाँ। संदेश बताता है कि क्या ग़लत है, कहाँ है, और उसे कैसे ठीक करें। असफल बिल्ड पिछली सही साइट को जस का तस छोड़ देता है।
एक प्रोग्राम¶
Guidedog एक ही बाइनरी है। आपको Python एनवायरनमेंट, LaTeX इंस्टॉलेशन, या अलग थीम और एक्सटेंशन पैकेज की ज़रूरत नहीं है। कॉन्फ़िगरेशन एक TOML फ़ाइल है, और टेम्पलेट आपके प्रोजेक्ट में रखी सादी फ़ाइलें हैं जिन्हें आप बदल सकते हैं।
कुछ चीज़ें अब भी बाहर से आती हैं। Guidedog को Typst और Graphviz अंदर रखकर बनाया जा सकता है; उनके बिना बना Guidedog आपके सिस्टम पर इंस्टॉल typst और Graphviz प्रोग्राम इस्तेमाल करता है। Linux और macOS पर यह libcurl जैसी कुछ सिस्टम लाइब्रेरियाँ भी इस्तेमाल करता है।
एक बार लिखें, दोनों देखें¶
बाईं ओर reStructuredText है। दाईं ओर वह है जो Guidedog ने उससे इसी पेज पर बनाया। PDF बिल्डर उन्हीं पंक्तियों को पुस्तक के पृष्ठ की तरह सजाता है।
.. note::
Guidedog आपका पाठ एक बार पढ़ता है।
*वही* फ़ाइलें **वेबसाइट** भी बनती हैं
और **पुस्तक** भी:
.. list-table::
:header-rows: 1
* - बिल्डर
- परिणाम
* - ``html``
- वेबसाइट
* - ``pdf``
- PDF पुस्तक
वही फ़ाइलें वेबसाइट भी बनती हैं और पुस्तक भी:
| बिल्डर | परिणाम |
|---|---|
html |
वेबसाइट |
pdf |
PDF पुस्तक |
PDF पुस्तक के रूप में मैनुअल काग़ज़ पर परिणाम का एक उदाहरण है। यह मैनुअल की वेबसाइट वाली फ़ाइलों से ही बना है।
शुरू करें¶
नवीनतम रिलीज़ से अपने सिस्टम के लिए आर्काइव डाउनलोड करें, guidedog को अपने PATH में रखें, और एक प्रोजेक्ट बनाएँ:
guidedog quickstart docs
guidedog build html docs
guidedog build pdf docs
guidedog serve docs
quickstart, conf.toml, index.rst और बदलने लायक़ टेम्पलेट लिखता है। serve आपके लिखते समय साइट दोबारा बनाता है। ट्यूटोरियल पहले प्रोजेक्ट को क़दम-दर-क़दम समझाता है। Guidedog को सोर्स से बनाने के लिए Odin इंस्टॉल करें और रिपॉज़िटरी के निर्देशों का पालन करें।
डिज़ाइन चर्चाएँ¶
Guidedog के डिज़ाइन फ़ैसले क्रमांकित चर्चाओं के रूप में लिखे गए हैं: समस्या, विकल्प, फ़ैसला और प्रमाण। हर चर्चा आप वेब पर पढ़ सकते हैं या PDF के रूप में डाउनलोड कर सकते हैं।