दस्तऐवजीकरणासाठी

1. तुमच्या दस्तऐवजाच्या मजकुरासह apps/content/docs/[language] फोल्डरमध्ये नवीन .mdx फाइल तयार करा.
2. साइटच्या नेव्हिगेशन मेनूमध्ये दस्तऐवज जोडा. हे करण्यासाठी, src/config/docs.ts फाइलमधील sidebarNav प्रॉपर्टीत अपेक्षित माहितीसह नवीन आयटम जोडा. विद्यमान आयटमचा नमुना फॉलो करा. असे केल्याने हा दस्तऐवज शोध कमांड पॅलेटमध्येही जोडला जाईल.

MDX दस्तऐवज सेटिंग्ज

MDX दस्तऐवज apps/content/docs/[language] आणि apps/content/blog/[language] फोल्डरमध्ये साठवले जातात. प्रत्येक दस्तऐवज ही एक MDX फाइल असते ज्यात शीर्षक आणि वर्णनासारख्या मेटाडेटासह हेडर असतो. खाली दस्तऐवज हेडरचे उदाहरण आहे:

---
title: Document Title
description: Document Description.
sort: 1
---

खालील मेटाडेटा फील्ड समर्थित आहेत:

• title (आवश्यक): दस्तऐवजाचे शीर्षक.
• description (आवश्यक): दस्तऐवजाचे थोडक्यात वर्णन.
• sort (पर्यायी): नेव्हिगेशनमध्ये दस्तऐवजाचा क्रम ठरवणारी संख्या. कमी sort मूल्य असलेले दस्तऐवज आधी दिसतात. दिले नसल्यास, दस्तऐवज शीर्षकानुसार वर्णक्रमाने लावले जातात.
• links (पर्यायी): संबंधित दस्तऐवज, API संदर्भ, स्रोत कोड इत्यादींचे दुवे.
• toc (पर्यायी): अनुक्रमणिका दाखवायची की नाही. डीफॉल्ट true.

दस्तऐवजात नवीन मेटाडेटा जोडण्यासाठी, तुम्ही हेडरमध्ये नवीन की जोडू शकता. उदाहरणार्थ, दस्तऐवज लेखक दाखवण्यासाठी author की जोडता येते:

---
title: Document Title
description: Document Description.
sort: 2
author: Author Name
---

परंतु कस्टम मेटाडेटा जोडताना, प्रोजेक्टच्या रूटमध्ये असलेली contentlayer.config.ts फाइल आणि त्यातील Doc किंवा Blog कॉन्स्टंटमधील fields प्रॉपर्टी देखील अपडेट करावी लागेल. यानंतर, दस्तऐवज टेम्पलेटमध्ये नवीन माहिती दाखवण्यासाठी src/app/[locale]/docs/[[...slug]]/page.tsx फाइल, किंवा src/app/[locale]/blog/[[...slug]]/page.tsx किंवा त्यातील एखादा child component अपडेट करावा लागेल.

Contentlayer पुन्हा बिल्ड करणे

दस्तऐवजीकरणातील मजकूर बदलल्यावर, नवीन docs जोडल्यावर, किंवा contentlayer.config.ts फाइल बदलल्यावर, विकासादरम्यान बदल लागू होण्यासाठी contentlayer cache पुन्हा बिल्ड करावी लागेल. चालवा:

cd apps/web
pnpm contentlayer:build

हा कमांड अॅप्लिकेशनला लागणारे content types आणि data पुन्हा तयार करतो. खालील वेळी हा कमांड चालवावा लागेल:

• contentlayer.config.ts फाइलमध्ये नवीन मेटाडेटा फील्ड जोडताना
• dev server चालू नसताना MDX content जोडताना किंवा बदलताना
• तुमच्या content organization ची रचना बदलताना

प्रॉडक्शनसाठी प्रोजेक्ट बिल्ड करताना हा कमांड आपोआप चालतो, पण development मध्ये structural content changes केल्यास तो manually चालवावा लागेल.