డాక్స్DocumentationContributingAdding new docs

కొత్త డాక్స్ జోడించడం

మీ డాక్యుమెంటేషన్ సైట్ మరియు బ్లాగ్‌కు కొత్త పత్రాలు జోడించండి.

డాక్యుమెంటేషన్ కోసం

  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 ఫైల్‌ను, లేక వాటి చైల్డ్ కంపోనెంట్‌లలో ఏదో ఒకదాన్ని నవీకరించాలి.

Contentlayer మళ్లీ నిర్మించడం

మీరు డాక్యుమెంటేషన్ కంటెంట్‌లో మార్పులు చేసినప్పుడు, కొత్త డాక్స్ జోడించినప్పుడు, లేదా contentlayer.config.ts ఫైల్‌ను సవరించినప్పుడు, డెవలప్‌మెంట్ సమయంలో ఆ మార్పులు అమల్లోకి రావాలంటే contentlayer క్యాష్‌ను మళ్లీ నిర్మించాలి. నడపండి:

cd apps/web
pnpm contentlayer:build

ఈ కమాండ్ అప్లికేషన్‌కు అవసరమైన కంటెంట్ టైప్‌లు మరియు డేటాను మళ్లీ సృష్టిస్తుంది. మీరు ఈ సందర్భాల్లో ఈ కమాండ్‌ను నడపాలి:

  • contentlayer.config.ts ఫైల్‌కు కొత్త మెటాడేటా ఫీల్డ్‌లు జోడించినప్పుడు
  • dev server నడవని సమయంలో MDX కంటెంట్ జోడించినప్పుడు లేదా మార్చినప్పుడు
  • మీ కంటెంట్ నిర్వహణ నిర్మాణాన్ని మార్చినప్పుడు

ప్రొడక్షన్ కోసం ప్రాజెక్ట్‌ను build చేసినప్పుడు ఈ కమాండ్ స్వయంచాలకంగా నడుస్తుంది, కానీ డెవలప్‌మెంట్ సమయంలో కంటెంట్‌కు నిర్మాణాత్మక మార్పులు చేస్తే దీన్ని మాన్యువల్‌గా నడపాలి.