Skip to content

नए कोड उदाहरण जोड़ना ​

कोड उदाहरणों के लिए योगदान दिशानिर्देश ​

  • सबमिशन अंग्रेज़ी में अनिवार्य रूप से लिखे होने चाहिए।
  • अपने उदाहरण को यथासंभव विस्तार से डॉक्यूमेंट करें।
  • सुनिश्चित करें कि आपका कोड ठीक से काम करता है और अच्छी तरह टेस्ट किया गया है।

हमारे पास निम्नलिखित अधिकार सुरक्षित हैं: ​

  • सबमिट किए जाने के बाद आपके योगदान में बदलाव करना।
  • आवश्यकता पड़ने पर आपके योगदान को हटाना।

नया कोड उदाहरण बनाना ​

1. इस रिपॉजिटरी को Fork करें ​

2. अपने fork को क्लोन करें और प्रोजेक्ट डायरेक्टरी में cd करें ​

3. VitePress इंस्टॉल करें ​

आप VitePress की पूर्वापेक्षाएं (prerequisites) आधिकारिक डॉक्यूमेंटेशन में देख सकते हैं।

sh
npm add -D vitepress@next
sh
pnpm add -D vitepress@next
sh
yarn add -D vitepress@next vue
sh
bun add -D vitepress@next

4. अपना कोड उदाहरण जोड़ें ​

4.1 उदाहरण फाइल बनाएं ​

  1. /docs/examples में प्रोग्रामिंग भाषा के नाम से एक नई फाइल बनाएं।
  2. फाइल का नाम .md पर समाप्त होना चाहिए।
  3. API कॉल करने के कम से कम दो अलग-अलग तरीके शामिल करें।

4.2 उदाहरण को साइडबार में जोड़ें ​

  1. /docs/.vitepress/config.mts खोलें।
  2. साइडबार में "Code Examples" सेक्शन ढूंढें।
  3. अपनी नई फाइल को सूची में जोड़ें।
  4. सूची को प्रोग्रामिंग भाषा के अनुसार वर्णमाला क्रम (alphabetical order) में रखें।

5. डेवलपमेंट सर्वर शुरू करें ​

पुल रिक्वेस्ट बनाने से पहले लोकल रूप से जांच लें कि आपके बदलावों से कुछ टूटा तो नहीं है।

sh
npm run dev
sh
pnpm run dev
sh
yarn dev
sh
bun run dev

6. पुल रिक्वेस्ट बनाएं ​

मूल रिपॉजिटरी में एक पुल रिक्वेस्ट सबमिट करें।