वैश्विक सेटिंग्स

प्रत्येक Mintlify साइट को मूल कॉन्फ़िगरेशन सेटिंग्स वाली docs.json फ़ाइल की आवश्यकता होती है। नीचे संपत्तियों के बारे में अधिक जानें।

संपत्तियाँ

namestringrequired

आपके प्रोजेक्ट का नाम। वैश्विक शीर्षक के लिए उपयोग किया जाता है।

उदाहरण: mintlify

navigationNavigation[]required

उस समूह के भीतर सभी पृष्ठों के साथ समूहों की एक सरणी

नेविगेशन

groupstring

समूह का नाम।

उदाहरण: Settings

pagesstring[]

मार्कडाउन फ़ाइलों के सापेक्ष पथ जो पृष्ठों के रूप में कार्य करेंगे।

उदाहरण: ["customization", "page"]

logostring or object

लोगो चित्र का पथ या "लाइट" और "डार्क" मोड लोगो चित्रों के पथ वाला ऑब्जेक्ट

लोगो

lightstring

लाइट मोड में लोगो का पथ

darkstring

डार्क मोड में लोगो का पथ

hrefstring

लोगो पर क्लिक करने पर आपको कहाँ ले जाता है

faviconstring

फ़ेविकॉन चित्र का पथ

colorsColors

आपके वैश्विक थीम के लिए हेक्स रंग कोड

रंग

primarystringrequired

प्राथमिक रंग। लाइट मोड में हाइलाइट की गई सामग्री, अनुभाग शीर्षक, और एक्सेंट के लिए सबसे अधिक उपयोग किया जाता है

lightstring

डार्क मोड के लिए प्राथमिक रंग। डार्क मोड में हाइलाइट की गई सामग्री, अनुभाग शीर्षक, और एक्सेंट के लिए सबसे अधिक उपयोग किया जाता है

darkstring

महत्वपूर्ण बटनों के लिए प्राथमिक रंग

backgroundobject

लाइट और डार्क दोनों मोड में पृष्ठभूमि का रंग

ऑब्जेक्ट

lightstringrequired

लाइट मोड में पृष्ठभूमि का हेक्स रंग कोड

darkstringrequired

डार्क मोड में पृष्ठभूमि का हेक्स रंग कोड

topbarLinksTopbarLink[]

उन लिंक के name और url की सरणी जिन्हें आप टॉपबार में शामिल करना चाहते हैं

TopbarLink

namestring

बटन का नाम।

उदाहरण: हमसे संपर्क करें

urlstring

बटन पर क्लिक करने पर URL। उदाहरण: https://mintlify.com/docs

topbarCtaButtonCall to Action

टॉपबार कॉल टू एक्शन

type"link" or "github"

लिंक एक बटन दिखाता है। GitHub दिए गए URL पर रिपो जानकारी दिखाता है जिसमें GitHub स्टार्स की संख्या शामिल है।

urlstring

यदि link: बटन किससे लिंक होता है।

यदि github: GitHub जानकारी लोड करने के लिए रिपॉज़िटरी का लिंक।

namestring

बटन के अंदर का पाठ। केवल आवश्यक यदि type link है।

versionsstring[]

संस्करण नामों की सरणी। इसका उपयोग केवल तभी करें जब आप नेविगेशन बार में ड्रॉपडाउन के साथ दस्तावेज़ के विभिन्न संस्करण दिखाना चाहते हैं।

anchorsAnchor[]

एंकर की एक सरणी, जिसमें icon, color, और url शामिल हैं।

एंकर

iconstring

एंकर को फ़ीचर करने के लिए उपयोग किया जाने वाला Font Awesome आइकन।

उदाहरण: comments

namestring

एंकर लेबल का नाम।

उदाहरण: सामुदायिक

urlstring

URL का प्रारंभ जो इंगित करता है कि कौन से पृष्ठ एंकर में जाते हैं। आमतौर पर, यह उस फ़ोल्डर का नाम है जिसमें आप अपने पृष्ठ रखते हैं।

colorstring

एंकर आइकन पृष्ठभूमि का हेक्स रंग। आप from और to गुणों वाला ऑब्जेक्ट पास करके ग्रेडिएंट भी हो सकते हैं जो प्रत्येक एक हेक्स रंग है।

versionstring

इसका उपयोग तब किया जाता है जब आप सही दस्तावेज़ संस्करण चुने जाने तक एंकर छिपाना चाहते हैं।

isDefaultHiddenboolean

यदि आप तब तक एंकर छिपाना चाहते हैं जब तक आप किसी को सीधे उसके अंदर दस्तावेज़ से लिंक नहीं करते तो true पास करें।

iconTypestring

इनमें से एक: "brands", "duotone", "light", "sharp-solid", "solid", या "thin"

topAnchorObject

शीर्ष-स्तरीय एंकर के लिए डिफ़ॉल्ट कॉन्फ़िगरेशन ओवरराइड करें।

ऑब्जेक्ट

namestring

शीर्ष-स्तरीय एंकर का नाम

iconstring

Font Awesome आइकन।

iconTypestring

इनमें से एक: "brands", "duotone", "light", "sharp-solid", "solid", या "thin"

tabsTabs[]

नेविगेशन टैब की एक सरणी।

टैब

namestring

टैब लेबल का नाम।

urlstring

URL का प्रारंभ जो इंगित करता है कि कौन से पृष्ठ टैब में जाते हैं। आमतौर पर, यह उस फ़ोल्डर का नाम है जिसमें आप अपने पृष्ठ रखते हैं।

apiAPI

API सेटिंग्स के लिए कॉन्फ़िगरेशन। API पृष्ठों के बारे में अधिक जानें API Components पर।

API

baseUrlstring

सभी API endpoints के लिए बेस URL। यदि baseUrl एक सरणी है, तो यह उपयोगकर्ता द्वारा टॉगल किए जा सकने वाले कई बेस URL विकल्पों को सक्षम करेगा।

authAuth

प्रमाणीकरण

method"bearer" | "basic" | "key"

सभी API endpoints के लिए उपयोग की जाने वाली प्रमाणीकरण रणनीति।

namestring

API playground में उपयोग किए जाने वाले प्रमाणीकरण पैरामीटर का नाम।

यदि method basic है, तो प्रारूप [usernameName]:[passwordName] होना चाहिए

inputPrefixstring

डिफ़ॉल्ट मान जो प्रमाणीकरण इनपुट फ़ील्ड के लिए प्रीफ़िक्स होने के लिए डिज़ाइन किया गया है।

उदा. यदि AuthKey का inputPrefix है तो प्रमाणीकरण फ़ील्ड का डिफ़ॉल्ट इनपुट परिणाम AuthKey के रूप में विरासत में मिलेगा।

playgroundPlayground

API playground के लिए कॉन्फ़िगरेशन

playground

mode"show" | "simple" | "hide"

क्या playground दिखाया जा रहा है, छिपा है, या केवल बिना किसी अतिरिक्त उपयोगकर्ता इंटरैक्टिविटी के endpoint दिखा रहा है simple

अधिक जानें playground guides पर

maintainOrderboolean

इस फ़्लैग को सक्षम करने से यह सुनिश्चित होता है कि OpenAPI पृष्ठों में कुंजी क्रम OpenAPI फ़ाइल में परिभाषित कुंजी क्रम से मेल खाता है।

warning

यह व्यवहार जल्द ही डिफ़ॉल्ट रूप से सक्षम हो जाएगा, जिस समय यह फ़ील्ड बेकार हो जाएगा।

openapistring | string[]

आपकी OpenAPI फ़ाइल की ओर इंगित करने वाले URL(s) या सापेक्ष पथ(s) की एक स्ट्रिंग या स्ट्रिंग की सरणी।

उदाहरण:

"openapi": "https://example.com/openapi.json"

"openapi": "/openapi.json"

"openapi": ["https://example.com/openapi1.json", "/openapi2.json", "/openapi3.json"]

footerSocialsFooterSocials

सोशल मीडिया खातों का एक ऑब्जेक्ट जहाँ कुंजी:गुण जोड़ी सोशल मीडिया प्लेटफ़ॉर्म और खाता URL का प्रतिनिधित्व करती है।

उदाहरण:

{
  "x": "https://x.com/mintlify",
  "website": "https://mintlify.com"
}

FooterSocials

[key]string

निम्नलिखित मानों में से एक website, facebook, x, discord, slack, github, linkedin, instagram, hacker-news

उदाहरण: x

propertystring

सोशल प्लेटफ़ॉर्म का URL।

उदाहरण: https://x.com/mintlify

feedbackFeedback

प्रतिक्रिया बटन सक्षम करने के लिए कॉन्फ़िगरेशन

प्रतिक्रिया

suggestEditboolean

उपयोगकर्ताओं को pull requests के माध्यम से संपादन सुझाने की अनुमति देने वाला बटन सक्षम करता है

raiseIssueboolean

उपयोगकर्ताओं को दस्तावेज़ीकरण के बारे में समस्या उठाने की अनुमति देने वाला बटन सक्षम करता है

modeToggleModeToggle

डार्क मोड टॉगल अनुकूलित करें।

ModeToggle

default"light" or "dark"

यदि आप नए उपयोगकर्ताओं के लिए हमेशा लाइट या डार्क मोड दिखाना चाहते हैं तो सेट करें। जब सेट नहीं होता, तो हम उपयोगकर्ता के ऑपरेटिंग सिस्टम के समान मोड पर डिफ़ॉल्ट करते हैं।

isHiddenboolean

डार्क/लाइट मोड टॉगल छिपाने के लिए true सेट करें। आप अपने दस्तावेज़ों को केवल लाइट या डार्क मोड का उपयोग करने के लिए मजबूर करने के लिए isHidden को default के साथ जोड़ सकते हैं। उदाहरण:

"modeToggle": {
  "default": "dark",
  "isHidden": true
}

"modeToggle": {
  "default": "light",
  "isHidden": true
}

backgroundImagestring

हर पृष्ठ के पीछे प्रदर्शित किया जाने वाला पृष्ठभूमि चित्र। उदाहरण देखें Infisical और FRPC के साथ।