GitHub README में ASCII बैनर कैसे जोड़ें
इसे Markdown कोड ब्लॉक में रखें और 80 कॉलम से कम रखें।
ASCII बैनर में लिखा प्रोजेक्ट का नाम README के ऊपरी हिस्से को अलग दिखाता है। इमेज के उलट यह सादा टेक्स्ट है: रिपॉज़िटरी में कोई फ़ाइल नहीं जुड़ती और यह लाइट और डार्क दोनों थीम में सही दिखता है।
README में जोड़ना
Markdown में बैनर कोड ब्लॉक के अंदर होना चाहिए। उसके बाहर कई स्पेस मिलकर एक हो जाते हैं, और _ व * इटैलिक और बोल्ड के निशान बन जाते हैं, जिससे आर्ट बिगड़ जाती है।
```text
_ _
_ __ ___ _ _ _ __ _ __ ___ (_) ___ ___| |_
| '_ ` _ \| | | |_____| '_ \| '__/ _ \| |/ _ \/ __| __|
| | | | | | |_| |_____| |_) | | | (_) | | __/ (__| |_
|_| |_| |_|\__, | | .__/|_| \___// |\___|\___|\__|
|___/ |_| |__/
```
# my-project
एक छोटा CLI टूल जिसे सीधे टर्मिनल से चलाया जा सकता है।
- खुलने वाले बैकटिक के बाद
textलिखने से सिंटैक्स हाइलाइटिंग बंद हो जाती है और अक्षर एक ही रंग में रहते हैं। - बैनर के नीचे असली टेक्स्ट हेडिंग (
# my-project) जोड़ें। सर्च इंजन और स्क्रीन रीडर बैनर को प्रोजेक्ट के नाम के रूप में नहीं पढ़ सकते। - अगर आर्ट में लगातार तीन बैकटिक हों, तो उसे चार बैकटिक में रखें।
80 कॉलम से कम रखें
GitHub पर लाइन बहुत लंबी हो तो कोड ब्लॉक बगल में स्क्रॉल होता है। कटा हुआ बैनर बेकार है, इसलिए 80 कॉलम से कम रखें, या फ़ोन पर भी फ़िट करना हो तो लगभग 50।
| कहाँ पढ़ा जाएगा | सुझाई गई चौड़ाई |
|---|---|
| डेस्कटॉप पर GitHub README | 80 कॉलम तक |
| GitHub मोबाइल ऐप, पतली स्क्रीन | लगभग 50 कॉलम |
| टर्मिनल आउटपुट | 80 कॉलम तक |
लंबे प्रोजेक्ट नाम के लिए Standard या Big की जगह Small या Mini जैसा छोटा फ़ॉन्ट चुनें, या नाम को दो लाइनों में बाँटें। lab.ascii पर हर फ़ॉन्ट कार्ड के ऊपर दाएँ कोने में नतीजे की चौड़ाई दिखती है।
कोड कमेंट में जोड़ना
फ़ाइल की शुरुआत या किसी बड़े सेक्शन की शुरुआत में बैनर लंबी फ़ाइल में अपनी जगह ढूँढना आसान बनाता है।
/*
* ___ ___ _ _ ___ ___ ___
* | _ \ __| \| | \| __| _ \
* | / _|| .` | |) | _|| /
* |_|_\___|_|\_|___/|___|_|_\
*/
export function render() {}
- हर लाइन कमेंट चिह्न (
*,//या#) से शुरू करें। - अगर आर्ट में
*/हो, तो ब्लॉक कमेंट वहीं ख़त्म हो जाता है। ऐसी आर्ट के लिए//लाइन कमेंट इस्तेमाल करें। - अगर आपकी टीम लाइन की लंबाई की सीमा रखती है, जैसे 100 अक्षर, तो बैनर उसके अंदर रखें।
प्रोग्राम शुरू होने पर दिखाना
CLI टूल शुरू होते समय बैनर दिखाने के लिए आर्ट को स्ट्रिंग के रूप में रखना होता है। समस्या है बैकस्लैश (\)। ज़्यादातर भाषाओं में बैकस्लैश एस्केप सीक्वेंस शुरू करता है, इसलिए आर्ट जैसी है वैसी पेस्ट करने से अक्षर छूट जाते हैं या एरर आता है।
JavaScript में String.raw बैकस्लैश को जैसा है वैसा रखता है।
const banner = String.raw`
_ _ ___ _ _ ___
| || | __| | | | / _ \
| __ | _|| |__| |_| (_) |
|_||_|___|____|____\___/
`;
console.log(banner);
आर्ट के अंदर बैकटिक या ${ टेम्पलेट स्ट्रिंग को ख़त्म कर देता है। आमतौर पर ऐसी आर्ट के लिए दूसरा फ़ॉन्ट चुनना आसान होता है।
Python में आगे r लगाकर raw string इस्तेमाल करें।
BANNER = r"""
_ _ ___ _ _ ___
| || | __| | | | / _ \
| __ | _|| |__| |_| (_) |
|_||_|___|____|____\___/
"""
print(BANNER)
दो नियम मानें, तो स्टार्टअप बैनर परेशान नहीं करता।
- जब आउटपुट किसी दूसरे प्रोग्राम, जैसे पाइप या लॉग फ़ाइल, में जा रहा हो तो इसे न दिखाएँ।
- इसे बंद करने के लिए
--quietजैसा विकल्प दें।
कौन-सा फ़ॉन्ट इस्तेमाल करें?
| फ़ॉन्ट | स्वभाव |
|---|---|
| Standard | सुरक्षित डिफ़ॉल्ट। हर नाम पर जँचता है |
| Slant | तिरछे अक्षर, रफ़्तार का एहसास |
| Small | छोटा Standard। लंबे नामों के लिए अच्छा |
| Banner | # से भरे भारी अक्षर। सबसे ज़्यादा ध्यान खींचता है |
| Digital | तीन लाइनों का छोटा बैनर, हर अक्षर एक बॉक्स में। कोड कमेंट के लिए अच्छा |
lab.ascii के सभी 12 फ़ॉन्ट सिर्फ़ ASCII अक्षर इस्तेमाल करते हैं, इसलिए GitHub, टर्मिनल और पुराने वातावरण में भी सही रहते हैं। दूसरे जनरेटर के ब्लॉक अक्षरों (█ ╗ ═) वाले बैनर बहुत पुराने वातावरण में बिगड़ सकते हैं, इसलिए अगर बैनर हर जगह चलना चाहिए तो ASCII फ़ॉन्ट चुनें।
lab.ascii पर अपने प्रोजेक्ट का नाम लिखकर 12 फ़ॉन्ट में बैनर की तुलना करें और कॉपी करने के लिए कार्ड पर क्लिक करें।