आपकी पहली परियोजना¶
लक्ष्य छोटा है: एक पृष्ठ ब्राउज़र में और वही पृष्ठ PDF में। पहले Guidedog तैयार करें। PDF के लिए अंतर्निहित कंपाइलर या स्थापित Typst 0.15.1 या नया संस्करण इस्तेमाल कर सकते हैं। Guidedog बिल्ड और इंस्टॉल करना देखें।
macOS पर brew install insanai/guidedog/guidedog से रिलीज़ स्थापित करें। यह आधिकारिक tap जोड़ता है और PDF कंपाइलर भी स्थापित करता है।
परियोजना बनाएँ¶
ऐसी निर्देशिका से चलाएँ जहाँ अभी notes न हो:
guidedog quickstart notes -q -p "Field Notes" -a "Your name" -v 1.0
Guidedog कॉन्फ़िगरेशन, पहला RST दस्तावेज़ और संपादन योग्य टेम्पलेट लिखता है। चित्र, ऑडियो और वीडियो के फ़ोल्डर भी बनाता है। मौजूदा परियोजना पर नहीं लिखता।
notes/
conf.toml
index.rst
_templates/
layout.html
book.typ
_static/
guidedog.css
guidedog.js
assets/
images/
audio/
video/
_build/
RST फ़ाइलों में सामग्री और टेम्पलेट में प्रस्तुति रहती है। quickstart मूल _templates/layout.html और _templates/book.typ को परियोजना में ही रखता है, बाहरी थीम या कैश में नहीं। इन्हें कभी भी देख और बदल सकते हैं।
पहला पृष्ठ लिखें¶
notes/index.rst इससे बदलें:
Field Notes
===========
A useful explanation begins with a small example.
Measuring a square
------------------
If the side has length :math:`s`, its area is :math:`s^2`.
.. math::
A = s^2
.. note::
State the units before comparing measurements.
बिल्ड और निरीक्षण¶
guidedog build html notes -W
guidedog build pdf notes -W
notes/_build/html/index.html और notes/_build/pdf का PDF खोलें। -W चेतावनी पर बिल्ड विफल करता है; इसे दस्तावेज़ जाँच में रखें। HTML पृष्ठ में नेविगेशन और पाठ हैं। PDF में किताब के पृष्ठ-संबंधी तत्व जुड़ते हैं। गणित हर आउटपुट के लिए सजता है। सेटअप गणित और प्रमाण में है।
बदलाव करें¶
guidedog serve notes
कमांड का दिखाया पता खोलें। स्रोत बदलकर सहेजें और ब्राउज़र रिफ़्रेश करें। HTML भेजने से पहले Guidedog स्रोत के बदलाव का समय जाँचता है और नया होने पर फिर बिल्ड करता है। यह ब्राउज़र को रीलोड नहीं भेजता। सर्वर Ctrl+C से रोकें।
कुछ बदले बिना फिर बिल्ड करें। अपरिवर्तित दस्तावेज़ फिर इस्तेमाल होते हैं। आउटपुट नया है यह साबित करने के लिए हर पृष्ठ फिर पढ़ना ज़रूरी नहीं। एक छोटी किताब बनाएँ पर आगे बढ़ें।