# Markdown में लिखें

जाने-पहचाने Markdown से ड्राफ़्ट तैयार करें और सहयोगियों के लिए PDF या संपादन योग्य डॉक्यूमेंट बनाएँ।

Markdown रिसर्च नोट्स, रिपोर्ट और शुरुआती ड्राफ़्ट के लिए अच्छी तरह काम करता है। Oleafly इसे एक समर्पित फ़ॉर्मैटिंग टूलबार और Pandoc बिल्ड पाथ देता है, साथ में ऐप के बाहर भी इस्तेमाल होने वाली सोर्स फ़ाइलें।

## एक रिपोर्ट बनाएँ

1. **New project → Use a template → Blank Markdown document** चुनें।
2. प्रोजेक्ट का नाम **फ़ील्ड नोट्स** रखें और `main.md` खोलें।
3. यह उदाहरण पेस्ट करें, फिर **Recompile** चुनें या **⌘Enter / Ctrl+Enter** दबाएँ।
4. अगर Oleafly किसी ज़रूरी इंजन का सेटअप करने की पेशकश करे, तो वह सेटअप पूरा करके दोबारा कंपाइल करें।

```markdown title="main.md"
---
title: "Field notes"
author: "Alex Chen"
date: ""
---

# Question

Does the revised procedure reduce measurement time?

## Method

1. Prepare the sample.
2. Repeat the measurement three times.
3. Record the elapsed time.

## Observations

| Run | Time (s) | Note |
| --- | --- | --- |
| 1 | 12 | First pass |
| 2 | 10 | Repeated pass |

The **mean time** will be compared with the baseline.
```

PDF में एक टाइटल, हेडिंग, एक क्रमांकित सूची और एक टेबल होनी चाहिए। पहली `---` लाइनों की जोड़ी के बीच का मेटाडेटा डॉक्यूमेंट का टाइटल और लेखक तय करता है।

## दस्तावेज़ के प्रकार

दस्तावेज़ को रिपोर्ट, किताब, स्लाइड, पोस्टर, पत्र या CV के रूप में बिल्ड करने के लिए फ़्रंट मैटर में `type` पंक्ति जोड़ें। `type` के बिना, या ऐसे मान के साथ जिसे Oleafly नहीं जानता, दस्तावेज़ लेख के रूप में बिल्ड होता है।

| `type` | वह क्या बिल्ड करता है | जब तक आप सेट न करें, यह भर दिया जाता है |
| --- | --- | --- |
| `article` | लेख | कुछ नहीं |
| `report` या `thesis` | रिपोर्ट, हर `#` शीर्षक पर एक अध्याय के साथ | `documentclass: report` |
| `book` | किताब, हर `#` शीर्षक पर एक अध्याय के साथ | `documentclass: book` |
| `slides` | 16:9 Beamer स्लाइड। `#` शीर्षक एक अनुभाग शुरू करता है और `##` शीर्षक एक स्लाइड | `aspectratio: 169` |
| `poster` | एक पन्ने का Beamer पोस्टर, जिसके शीर्ष पर उसका `title`, `subtitle`, `author` और `institute` होता है | A0 पेपर, पोर्ट्रेट |
| `letter` | आपके और प्राप्तकर्ता के पते, विषय पंक्ति, संबोधन और समापन वाला पत्र | `documentclass: scrlttr2` |
| `cv` | एक सघन लेख | `geometry: margin=2cm` और `pagestyle: empty` |

आपका अपना फ़्रंट मैटर प्राथमिकता पाता है। जो मान आप खुद सेट करते हैं, जैसे `documentclass`, `aspectratio` या `geometry`, वह उस मान की जगह लेता है जिसे टाइप भर देता है।

स्लाइड के लिए, `slide-level` सेट करके वह शीर्षक स्तर चुनें जो स्लाइड शुरू करता है। `slide-level: 1` के साथ हर `#` शीर्षक एक स्लाइड शुरू करता है। स्लाइड सामान्य PDF के रूप में बिल्ड होती हैं, इसलिए प्रीव्यू टूलबार का **Present** उन्हें दिखा सकता है। [स्लाइड प्रेज़ेंट करना](/docs/present-slides/) देखें।

पोस्टर तब तक A0 होता है जब तक आप `papersize` को `a1`, `a2`, `a3` या `a4` पर सेट न करें। `letter` या `a5` जैसे दूसरे आकार अनदेखे कर दिए जाते हैं। चौड़े पोस्टर के लिए `orientation: landscape` जोड़ें।

पत्र प्राप्तकर्ता का पता `to` से लेता है और आपका `from` से। `opening` अभिवादन है, और `closing` आपके नाम से पहले की पंक्ति है, जो `author` से आता है। `subject` विषय पंक्ति बनता है, या `subject` न हो तो `title`। पते को सूची के रूप में लिखें, हर आइटम पर एक पंक्ति।

```markdown title="main.md"
---
type: letter
author: "Alex Chen"
from:
  - "Department of Physics"
  - "1 University Road"
to:
  - "Dr. Sam Lee"
  - "Editorial Office"
subject: "Revised manuscript"
opening: "Dear Dr. Lee,"
closing: "Yours sincerely,"
---

Thank you for the reviewers' comments. The revised manuscript answers each one.
```

[Document settings](/docs/document-settings/#markdown) में **Document type** आपके लिए `type` पंक्ति लिख देता है। [LaTeX एक्सपोर्ट](/docs/export/#what-each-format-keeps) भी टाइप का अनुसरण करता है, और स्लाइड का [PowerPoint एक्सपोर्ट](/docs/export/#presentation-and-book-exports) वही `slide-level` इस्तेमाल करता है। [`oleafly build`](/docs/cli/#build-a-project) हर टाइप को वैसे ही बिल्ड करता है जैसे ऐप करता है।

## सोर्स और विज़ुअल एडिटिंग

टूलबार के शुरू में मौजूद स्विच के तीन मोड हैं। **Code** Markdown को सीधे संपादित करता है। **Visual** हेडिंग, पैराग्राफ़, सूचियों, लिंक, इमेज और टेबल के लिए फ़ॉर्मैट हुआ संपादन देता है। **Both** सोर्स और फ़ॉर्मैट हुआ टेक्स्ट साथ दिखाता है। **Stacked** या **Split** चुनने के लिए इसका मेन्यू खोलें। नए प्रोजेक्ट Code में खुलते हैं, और हर प्रोजेक्ट उस मोड को याद रखता है जिसमें आपने उसे छोड़ा था।

Underline, Highlight, Superscript और Subscript Code मोड में Pandoc फ़ॉर्मैटिंग कंट्रोल हैं। उनके बटन Visual मोड में छिपे रहते हैं। मेटाडेटा, साइटेशन सिंटैक्स या दूसरे सोर्स कंस्ट्रक्ट के साथ काम करते समय Code इस्तेमाल करें।

[उदाहरण का सोर्स डाउनलोड करें](/examples/writing-example.md)

## हर टूलबार टूल

फ़ॉर्मैटिंग कंट्रोल पर क्लिक करने से पहले टेक्स्ट चुनें। Code मोड में ज़्यादातर टूल सेलेक्शन को रैप करते हैं या प्लेसहोल्डर जोड़ते हैं। बार में समा न सकने वाले कंट्रोल तक पहुँचने के लिए **More formatting options** (`…`) खोलें।

### Code / Visual

**Code**, **Visual** और **Both** के बीच बदलें। हर मोड में डॉक्यूमेंट Markdown सोर्स ही रहता है।

### Undo

अंतिम बदलाव पूर्ववत करें। ⌘Z / Ctrl+Z।

### Redo

पूर्ववत किया बदलाव वापस लाएँ। **⌘Shift+Z / Ctrl+Shift+Z**।

### Heading → Title

हेडिंग मेन्यू से **Title** चुनकर `# Title` जोड़ें। हेडिंग टेक्स्ट को अपने टाइटल से बदलें।

### Heading → Section

हेडिंग मेन्यू से **Section** चुनकर `## Section` जोड़ें। हेडिंग टेक्स्ट को अपने टाइटल से बदलें।

### Heading → Subsection

हेडिंग मेन्यू से **Subsection** चुनकर `### Subsection` जोड़ें। हेडिंग टेक्स्ट को अपने टाइटल से बदलें।

### Heading → Subsubsection

हेडिंग मेन्यू से **Subsubsection** चुनकर `#### Subsubsection` जोड़ें। हेडिंग टेक्स्ट को अपने टाइटल से बदलें।

### Heading → Minor heading

हेडिंग मेन्यू से **Minor heading** चुनकर `##### Minor heading` जोड़ें। हेडिंग टेक्स्ट को अपने टाइटल से बदलें।

### Heading → Paragraph heading

हेडिंग मेन्यू से **Paragraph heading** चुनकर `###### Paragraph heading` जोड़ें। हेडिंग टेक्स्ट को अपने टाइटल से बदलें।

### Bulleted list

अक्रमित सूची शुरू करें। `- Item`।

### Numbered list

एक क्रम शुरू करें। `1. Item`।

### Task list

Code मोड में एक टास्क जोड़ें और पूरा होने पर `[ ]` को `[x]` कर दें। `- [ ] Task`।

### Blockquote

किसी उद्धरण को उसकी अपनी लाइन पर रखें। `> quoted text`।

### Bold

चुने हुए टेक्स्ट पर ज़ोर दें। `**text**`; ⌘B / Ctrl+B।

### Italic

किसी पद पर ज़ोर दें। `*text*`; ⌘I / Ctrl+I।

### Strikethrough

टेक्स्ट को अप्रचलित चिह्नित करें। `~~text~~`।

### Inline code

फ़ाइलनाम, कमांड या आइडेंटिफ़ायर फ़ॉर्मैट करें। बैकटिक में बंद टेक्स्ट।

### Underline

Code मोड में कोई वाक्यांश चुनें। `[text]{.underline}`।

### Highlight

Code मोड में कोई वाक्यांश चुनें। `[text]{.mark}`।

### Superscript

Code मोड में घातांक चुनें। `^text^`।

### Subscript

Code मोड में अधोलेख चुनें। `~text~`।

Underline और Highlight Pandoc एट्रिब्यूट इस्तेमाल करते हैं ताकि फ़ॉर्मैटिंग PDF तक पहुँच सके। पांडुलिपि में raw HTML टैग जोड़ने की जगह इन कंट्रोल का इस्तेमाल करें।

### Insert link

**Code** मोड में: `[link text](url)` जोड़ता है। दोनों प्लेसहोल्डर बदलें।

**Visual** मोड में: **Link URL** खोलता है। पता डालें और उसे अपने सेलेक्शन पर लागू करें। लिंक हटाकर सिर्फ़ टेक्स्ट रखने के लिए **Remove link** इस्तेमाल करें।

### Insert image

**Code** मोड में: `![caption](image-filename)` जोड़ता है। पाथ और कैप्शन बदलें।

**Visual** मोड में: **Image file** खोलता है। `figures/plot.png` जैसा कोई प्रोजेक्ट पाथ डालें और लागू करें।

PNG, JPG, PDF, SVG, GIF, WebP और BMP इमेज सब PDF में जाती हैं। SVG, GIF और WebP को Oleafly कंपाइल करते समय आपके लिए बदल देता है। TIFF, AVIF, HEIC और JPEG XL इमेज नहीं जा सकतीं: कंपाइल रुक जाता है और फ़ाइल का नाम बताता है, इसलिए उसे बाकी फ़ॉर्मैट में से किसी में सहेजें और फिर कंपाइल करें। अगर कोई रूपांतरण विफल हो, तो जाँचें कि इमेज खुलती है, या उसे PNG या PDF के रूप में सहेजें।

### Insert table

**Code** मोड में: तीन कॉलम, एक हेडर और दो डेटा पंक्तियाँ जोड़ता है। कॉलम के नाम और सेल बदलें।

**Visual** मोड में: वही शुरुआती आकार लेकर संपादन योग्य टेबल जोड़ता है।

### Draw a diagram

[डायग्राम कंपोज़र](/docs/figures-diagrams/) को Mermaid मोड में खोलता है। कैनवास पर फ़्लोचार्ट बनाएँ या Mermaid कोड संपादित करें, फिर उसे कर्सर पर फ़ेंस्ड `mermaid` कोड ब्लॉक के रूप में जोड़ने के लिए **Insert as Mermaid** चुनें। [Mermaid डायग्राम](#mermaid-diagrams) देखें।

### Document insights

डॉक्यूमेंट की हेडिंग, फ़िगर, टेबल, समीकरण, लेबल, साइटेशन और TODO सोर्स क्रम में सूचीबद्ध करता है, हर एक उसकी लाइन से जुड़ा हुआ। यह फ़्रंट मैटर से टाइटल, लेखक, कीवर्ड, तारीख़ और एब्स्ट्रैक्ट भी पढ़ता है और सबमिशन फ़ॉर्म के लिए उन्हें कॉपी कर सकता है। [डॉक्यूमेंट इनसाइट्स](/docs/document-insights/) देखें।

### Document settings

डॉक्यूमेंट टाइप, डॉक्यूमेंट क्लास, पेज का आकार, कॉलम, मार्जिन, बॉडी फ़ॉन्ट, फ़ॉन्ट का आकार, भाषा, लाइन स्पेसिंग और सेक्शन नंबरिंग बदलता है। Oleafly आपकी पसंद उस YAML फ़्रंट मैटर में लिखता है जिसे Pandoc पढ़ता है, और फ़ाइल में फ़्रंट मैटर न होने पर उसका ब्लॉक जोड़ देता है। [डॉक्यूमेंट सेटिंग्स](/docs/document-settings/#markdown) देखें।

### Project info

**Code** मोड में: प्रोजेक्ट के आँकड़े और सेलेक्शन की जानकारी दिखाता है।

**Visual** मोड में: विज़ुअल एडिटिंग सतह के आँकड़े दिखाता है।

### Find

**Code** मोड में: ⌘F / Ctrl+F के साथ सक्रिय फ़ाइल की खोज खोलता है।

**Visual** मोड में: सोर्स टूलबार का Find बटन छिपा रहता है।

किसी इमेज को संदर्भित करने से पहले उसे फ़ाइल ट्री से इंपोर्ट करें। इमेज पाथ को पांडुलिपि के सापेक्ष रखें, ताकि सोर्स आर्काइव किसी दूसरे कंप्यूटर पर भी काम करे।

![Markdown लैब नोटबुक सोर्स और विज़ुअल व्यू में संपादित की गई, और तालिका व टू-डू सूची दोनों में एक जैसी बनी रहीं।](https://cdn.oleafly.com/images/gifs/desktop/markdown-notebook.gif?v=2)

## समीकरण और कोड ब्लॉक

इनलाइन गणित को `$x^2$` की तरह लिखें। डिस्प्ले समीकरण को डॉलर चिह्नों की दो जोड़ियों के बीच रखें:

```markdown
$$
\bar{x} = \frac{1}{n}\sum_{i=1}^{n}x_i
$$
```

कोड सैंपल के लिए, कोड को तीन बैकटिक में बंद करें और उसकी भाषा को शुरुआती फ़ेंस के बाद लिखें। ये सोर्स कंस्ट्रक्ट हैं; Markdown टूलबार में समीकरण या फ़ेंस्ड कोड ब्लॉक का अलग बटन नहीं है।

Visual मोड में, फ़ेंस्ड ब्लॉक कोड ब्लॉक ही रहता है और अपनी भाषा और ख़ाली पंक्तियाँ बनाए रखता है, इसलिए Mermaid डायग्राम बचे रहते हैं। नया ब्लॉक शुरू करने के लिए तीन बैकटिक टाइप करें, और ब्लॉक के भीतर इंडेंट करने के लिए Tab दबाएँ।

## Mermaid डायग्राम

डायग्राम कंपोज़र में Mermaid फ़्लोचार्ट बनाने के लिए टूलबार पर **Draw a diagram** चुनें। **Insert as Mermaid** उसे फ़ेंस्ड कोड ब्लॉक के रूप में जोड़ता है:

````markdown
```mermaid
flowchart LR
  A[Sample] --> B[Measure]
```
````

**Both** मोड में फ़ॉर्मैट हुआ पक्ष ब्लॉक को डायग्राम के रूप में बनाता है। PDF को इमेज चाहिए, इसलिए कंपोज़र एक रेंडर हुई PNG `figures/mermaid-<hash>.png` पर भी सहेजता है, और कंपाइल उस इमेज को ब्लॉक की जगह रख देता है। इसलिए डायग्राम कंपाइल हुए PDF में भी दिखता है, और Word, HTML, EPUB तथा PowerPoint एक्सपोर्ट में भी। अगर आप बाद में ब्लॉक को हाथ से संपादित करते हैं, तो आपके दोबारा कंपोज़र से डायग्राम जोड़ने या सहेजने तक PDF कोड दिखाता है। [Markdown डॉक्यूमेंट में Mermaid](/docs/figures-diagrams/#mermaid-in-markdown-documents) देखें।

## दूसरी भाषाओं का टेक्स्ट

Oleafly डॉक्यूमेंट में मिली लिपियों के लिए फ़ॉन्ट चुन लेता है, इसलिए कोरियाई, जापानी, चीनी, अरबी, हिब्रू, ग्रीक, सिरिलिक, देवनागरी, थाई और कई अन्य लिपियाँ बिना किसी सेटअप के दिखती हैं। प्रतीकों और इमोजी को भी फ़ॉन्ट मिलता है, इमोजी श्वेत-श्याम में। मुख्य रूप से अरबी या हिब्रू में लिखा डॉक्यूमेंट दाएँ से बाएँ चलता है।

चीनी अक्षर चीनी और जापानी दोनों टेक्स्ट में आते हैं, इसलिए सही फ़ॉन्ट के लिए फ़्रंट मैटर में `lang` सेट करें: जापानी के लिए `ja`, सरलीकृत चीनी के लिए `zh`, पारंपरिक चीनी के लिए `zh-TW`, या कोरियाई के लिए `ko`। `lang` के बिना Oleafly टेक्स्ट के हिसाब से चलता है: काना का मतलब जापानी और हांगुल का मतलब कोरियाई।

```markdown title="main.md"
---
title: "実験ノート"
lang: ja
---
```

जो फ़ॉन्ट आप खुद चुनते हैं वे पहले आते हैं। जब फ़्रंट मैटर `mainfont` या `CJKmainfont` सेट करे, या `header-includes` फ़ॉन्ट सेट करे, तो Oleafly उस हिस्से को छोड़ देता है।

### PDF से ग़ायब अक्षर

जब इस्तेमाल हो रहे किसी फ़ॉन्ट में कोई अक्षर नहीं होता, तो PDF फिर भी उसके बिना बन जाती है, और कंपाइल ग़ायब अक्षरों के नमूने के साथ चेतावनी दिखाता है। इसे ठीक करने के लिए:

- कोरियाई, चीनी या जापानी टेक्स्ट के लिए, फ़्रंट मैटर में `CJKmainfont` को आपके कंप्यूटर पर इंस्टॉल ऐसे फ़ॉन्ट पर सेट करें जिसमें वे अक्षर हों।
- दूसरे टेक्स्ट के लिए, `mainfont` को उसी तरह सेट करें। [Document settings](/docs/document-settings/#markdown) में **Body font** उसे आपके लिए लिख देता है।
- किसी दुर्लभ प्रतीक के लिए, इसके बजाय इमेज का इस्तेमाल करें।

## उद्धरण और ग्रंथसूची

`references.bib` इंपोर्ट करें या बनाएँ, YAML मेटाडेटा में `bibliography: references.bib` जोड़ें, और किसी मौजूदा की को `[@citation-key]` से उद्धृत करें। Pandoc फ़ॉर्मैट किए उद्धरण और संदर्भ सूची बनाने के लिए ग्रंथसूची का इस्तेमाल करता है।

अगर फ़्रंट मैटर कोई ग्रंथसूची नहीं बताता, या ऐसी फ़ाइल बताता है जो मौजूद नहीं है, तो कंपाइल प्रोजेक्ट की वे `.bib` फ़ाइलें इस्तेमाल करता है जिनमें आपकी उद्धृत की हुई कुंजियाँ हों। जिस उद्धरण के लिए कोई ग्रंथसूची है ही नहीं, वह PDF में वैसा ही रहता है जैसा आपने लिखा, जैसे `[@smith2020]`, ताकि आप पहले लिख सकें और संदर्भ बाद में जोड़ सकें। जो डॉक्यूमेंट कुछ उद्धृत नहीं करता, वह कोई `.bib` फ़ाइल पढ़े बिना बनता है।

[संदर्भ खोजें और प्रबंधित करें →](/docs/citations/)

## इंपोर्ट और एक्सपोर्ट

किसी मौजूदा ड्राफ़्ट को Markdown में रखने के लिए, Blank Markdown document बनाएँ, ड्राफ़्ट को `main.md` में पेस्ट करें, और उसकी इमेज व ग्रंथसूची इंपोर्ट करें। लाइब्रेरी का अलग **Markdown document** इंपोर्ट फ़िलहाल ड्राफ़्ट को LaTeX में बदल देता है। [इंपोर्ट रास्ते](/docs/import-project/) दोनों रास्ते समझाते हैं।

PDF के लिए कंपाइल करें, या Word, HTML, Typst, LaTeX, PowerPoint, EPUB या प्लेन टेक्स्ट बनाने के लिए **Export** इस्तेमाल करें। LaTeX और Typst में एक्सपोर्ट ग्रंथसूची रखते हैं, और आपकी इमेज फ़ाइलों की प्रति बनाने के बजाय उनसे लिंक करते हैं, इसलिए उन फ़ाइलों को एक्सपोर्ट के बगल में रखें। जब Pandoc कुछ छोड़ देता है, तो एक्सपोर्ट चेतावनियों के साथ सहेजा जाता है, और **Show warnings** बताता है कि क्या छूटा। मूल Markdown और उसके एसेट साझा करने के लिए सोर्स ZIP इस्तेमाल करें। [अपना काम एक्सपोर्ट करें](/docs/export/) इस क्रम और बदली हुई फ़ाइल में करने योग्य जाँचों को समझाता है।
