نشان ھڻڻ

سٺو ڏينهن، ساٿيو! سکيا جي هڪ ڊگهي سفر کان پوء، هرڪو چاهي ٿو نوڪر کي پنهنجو ميوو ڏيکارڻ، ۽ انهن کي صرف بهترين، پيشه ورانه پاسي کان، صحيح؟ مان سمجهان ٿو ها. تنهن ڪري، هڪ صحيح طرح سان ٺهيل ۽ لاڳو ڪيل منصوبي کان علاوه، اسان کي ان کي رسمي ڪرڻ جي ضرورت آهي. آجر توهان جي پروجيڪٽ جو سمورو ڪوڊ نه پڙهندو اهو سمجهڻ لاءِ ته اهو ڇا آهي ۽ ان ۾ ڇا شامل آهي؟ هن آرٽيڪل ۾، اسان آخر ۾ پوئين ٻن جو خلاصو ڪنداسين، يعني: مسلسل انٽيگريشن ۽ ڪوڊ ڪوريج ، ۽ اچو ته اوپن سورس پروجيڪٽ جي ”فرنٽ“ شيٽ تي سمجھون ته اسان پنهنجي پروجيڪٽ ۾ ڇا استعمال ڪيو ۽ اهو ڇا جي نمائندگي ڪري ٿو. اڄ اسان توهان سان مارڪ ڊائون بابت ڳالهائينداسين، اسان جي پسنديده سوال پڇو: "اهو ڇا آهي؟" ۽ "اهو ڇو آهي؟"، اچو ته اهو ڄاڻون ته اهو ڪٿي استعمال ٿئي ٿو ۽ ان سان ڪيئن ڪم ڪجي. اتي به ھڪڙو مثال ھوندو، اسان ان کي پنھنجي اوپن سورس پروجيڪٽ ۾ لاڳو ڪنداسين . سو، اچو ته هلون!

"Markdown" ڇا آهي؟

جيئن ته توهان ۽ مان پروگرامر آهيون، اسان فوري طور تي گوگل ڏانهن وينداسين ۽ پهرين وڪي لنڪ کولينداسين ، جنهن ۾ لکيل آهي: مارڪ ڊائون هڪ هلڪي وزن واري مارڪ اپ ٻولي آهي جنهن جي مقصد سان ٺاهي وئي آهي ته سڀ کان وڌيڪ پڙهڻ لائق ۽ آسانيءَ سان ايڊٽ ڪري سگهجي ٿو، پر ان لاءِ موزون آهي. ترقي يافته اشاعتن لاءِ ٻولين ۾ تبديلي (HTML، Rich Text ۽ ٻيا). هتي، ايماندار هجڻ لاء، مون وٽ شامل ڪرڻ لاء گهڻو ڪجهه ناهي، منهنجو خيال آهي ته اهو هڪ مڪمل وضاحت آهي.

اسان کي هن "مارڪ ڊائون" جي ضرورت ڇو آهي؟

ايماندار ٿيڻ لاءِ، اهو اصل ۾ ان کان سواءِ خراب ناهي: ڊي پر اچو ته اسان جو مقصد ياد رکون: هڪ قابل پروجيڪٽ ٽيمپليٽ لکڻ لاءِ جنهن ۾ اڳ ۾ ئي مسلسل انٽيگريشن آهي ۽ ڪوڊڪوف وسيلن تي ڪوڊ ڪوريج جا انگ اکر آهن. مون هن جو ذڪر ڇو ڪيو؟ ان کان علاوه، مارڪ ڊائون اسان کي انهن وسيلن مان ڊيٽا وٺڻ جي اجازت ڏيندو ۽ ڊيٽا پاڻ مهيا ڪندو، يا بيجز جيڪي اسان کي ريڊريٽ ڪندا جتي اسان کي اها معلومات حاصل ڪرڻ جي ضرورت آهي. اهو آسان آهي ته هر شي کي هڪ "عنوان" صفحي تي، بلڪه مختلف هنڌن تي پکڙيل هجي، ڇا اهو ناهي؟

اهو ڪٿي استعمال ٿيندو آهي؟

ڪو به ماڻهو جنهن پنهنجي ڪنهن به پروجيڪٽ کي GitHub تي گهٽ ۾ گهٽ هڪ ڀيرو اپلوڊ ڪيو آهي اهو ڄاڻي ٿو ته GitHub مسلسل توهان کي README فائل ٺاهڻ لاءِ دعوت ڏيڻ چاهي ٿو: هن فائل جي توسيع ڇا آهي؟ اھو صحيح آھي، بولٽ ڄاڻي ٿو مارڪ ڊائون! جيئن ته اسان اڳ ۾ ئي ڄاڻون ٿا، هي فائل تمام آساني سان ترتيب ڏنل آهي ڪيترن ئي فارميٽ ۾ ۽ تبديل ٿيل HTML ۾ اسان کي گهربل آهي. پر اچو ته اسان جو وقت وٺون ۽ جلدي نه ڪريو فوري طور تي ان کي سڌو سنئون GitHub ۾ شامل ڪريو.

ان سان ڪيئن ڪم ڪجي؟

پهرين، جيئن توهان محسوس ڪيو هوندو، اسان ان کي سڌو سنئون GitHub ۾ شامل ڪري سگهون ٿا ۽ اهو ڪم ڪندو! پر اسان کي هميشه ان کي صرف هڪ منصوبي ۾ شامل ڪرڻ جي ضرورت ناهي، مثال طور. يا مثال طور اسان وڌيڪ سوچڻ چاهيون ٿا ته اسان ان کي ڪيئن ٺاهيو. ۽ هتي GitHub هاڻي اسان لاء مناسب ناهي. ۽ عام طور تي، اسان مارڪ ڊائون فائلون ٺاهي سگهون ٿا نه رڳو انهن کي GitHub ڏانهن ڌڪڻ جي مقصد لاء. ٻيو، اسان ان کي سڌو سنئون IDEA ذريعي ٺاهي سگهون ٿا، جيڪو اسان اهو ڪنداسين، پر فوري طور تي نه، ڇو ته اسان کي هڪ ننڍڙي فائل لکڻ لاء هڪ طاقتور ترقياتي ماحول جي ضرورت آهي؟ هتي آئون سفارش ڪريان ٿو برائوزنگ جي فهرست کي آسان، ۽ ايترو آسان ناهي، مارڪ ڊائون فائل ايڊيٽر. پنهنجي لاءِ، مون هاروپڊ چونڊيو آهي ، اهو تمام سادو آهي، رسائي لائق آهي، جيڪو توهان لکي رهيا آهيو ان جي فوري نمائندگي آهي (IDEA پڻ ڪندو آهي)، ۽ هڪ نحوي اشارو آهي. ھي اھو آھي جيڪو ايڊيٽر ونڊو ڏسڻ ۾ اچي ٿو: ھتي مون پنھنجي ھڪڙي پروجيڪٽ جي تيار ڪيل README.md کوليو. کاٻي پاسي هڪ چيٽ شيٽ آهي، ساڄي پاسي هڪ ڊسپلي آهي، وچ ۾ متن آهي. هر شيء بلڪل ابتدائي ۽ سادي آهي. توھان پڻ بيج ڏسي سگھو ٿا، جن بابت اسين جلد ڳالهائينداسين. جيڪي انهن فائلن کي لکڻ جو هڪ مختلف طريقو چونڊيندا آهن - پريشان نه ٿيو، اهو سڀ ڪجهه مختلف هوندو گرافڪ انٽرفيس. متن، نحو ۽ ڊسپلي ۾ تبديلي نه ٿيندي. مثال اهو ڪم تمام سادو آهي: README.md لکو ته جيئن ان ۾ شامل هجي: پروجيڪٽ بابت معلومات (بيج سميت)، پروجيڪٽ کي امپورٽ ڪرڻ بابت معلومات، پروجيڪٽ تي عمل درآمد بابت معلومات، ليکڪ جي رابطن بابت معلومات. هر شيء بلڪل سادي ۽ ابتدائي آهي، جيئن مون اڳ ۾ ئي چيو آهي. اچو ته ڪاروبار ڏانهن وڃو.

1. اچو ته هڪ عنوان لکون - اسان جي منصوبي جو نالو.

   مکيه ۽ سڀ کان وڏو هيڊنگ هيش آپريٽر " # " استعمال ڪندي ٺاهيو ويو آهي ۽ پوءِ عنوان لکيو ويندو آهي. اسان جي صورت ۾:

   # ForJavaRushPublication

2. ان کان پوء اسان ٿورو ننڍو عنوان لکنداسين، ۽ اسين "پروجيڪٽ انفارميشن" لکنداسين. ننڍو هيڊر وڌيڪ " # " جي اڳيان آهي:

   ## Information

   ۽ پوء اسان پروجيڪٽ بابت معلومات لکنداسين.

3. اچو ته اسان جي مضمونن جي لنڪ داخل ڪريو. اهو بلڪل سادو ڪيو ويو آهي، ۽ جيڪڏهن توهان هاروپڊ استعمال ڪندا آهيو، ته پوءِ صرف چيٽ شيٽ ٽائپ ڪريو ۽ ٽيمپليٽ پاڻ داخل ٿي ويندو. نحو آهي: " [text](url) "؛

4. اچو ته بيج داخل ڪريون. اچو ته هتي هڪ ويجهي نظر وٺو.

   پهرين، اچو ته انهن کي ترتيب ڏيو ٽيبل جي صورت ۾، خوبصورتي لاء. اتي 2 ڪالمن ۽ 2 ڪالمن ھوندا. نحو ڪجهه هن طرح نظر ايندو:

   ۽ نتيجو هن طرح ٿيندو:

   اڳيون، اسان اسان جي بيج تي هائپر لنڪس داخل ڪنداسين، پر اسان انهن کي ڪٿي حاصل ڪري سگهون ٿا؟ مون گذريل مضمون ۾ ڏيکاريو ته ڪوڊڪوف ڪٿي حاصل ڪجي، پر مون اهو ذڪر نه ڪيو ته ڪهڙو حاصل ڪجي. جيئن ته اسان وٽ هڪ مارڪ ڊائون فائل آهي، اسان کي پڻ مارڪ ڊائون بيج جي ضرورت آهي:

   بس ان کي ڪاپي ڪريو ۽ ان کي پيسٽ ڪريو اسان جي مارڪ ڊائون ۾ ڪالم ۾. پر اهو نه وساريو ته Codecov ظاهر ٿيو JaCoCo برانچ ۾، پر ماسٽر ۾ نه، تنهنڪري توهان کي دستي طور تي درست ڪرڻو پوندو. Travis CI بيج سڌو سنئون پروجيڪٽ جي نالي جي سامهون ورتو ويو آهي، جتي تعمير لاگ آهي:

   اسان بيج چونڊيو، ۽ پوء سيٽنگون ونڊو پاپ اپ ٿيندي:

   اسان ضرور چونڊيو مارڪ ڊائون، ۽ شاخ جيڪا توهان کي ضرورت آهي. مان ٻن شاخن لاءِ README.md ٺاهيندس، ۽ اھي ڪجھ مختلف ھوندا، ڇاڪاڻ ته مون اڃا تائين ماسٽر برانچ ۾ ڪوڊڪوف لاڳو نه ڪيو آھي.




5. اچو ته ان پروجيڪٽ کي امپورٽ يا ڪلون ڪرڻ جي معلومات لکون. مان وضاحت نه ڪندس ته اهو ڪيئن ڪجي، پر توهان ان کي منهنجي README.md ۾ پڙهي سگهو ٿا. اسان انهن ٽيڪنالاجين جي باري ۾ لکنداسين جيڪي اسان اسان جي منصوبي ۾ استعمال ڪيون آهن، انهن سان ڳنڍيل رکڻ. اڃان تائين، هي هڪ تعليمي منصوبو آهي. خير، اچو ته رابطي جي معلومات لکون.




6. اسان جو مارڪ ڊائون تيار آهي. اسان کي اهو ڪرڻو آهي ته ان کي اسان جي منصوبي ۾ شامل ڪيو وڃي ۽ اسان ڪيو آهي. پر سڀ هڪ ڀيرو نه! اچو ته اسان جو IDEA کوليو، ۽ پلگ ان ۾ اسان چيڪ ڪريون ٿا ته توهان وٽ مارڪ ڊائون سپورٽ آهي:

   مون وٽ الٽيميٽ IDEA آهي، تنهن ڪري مون وٽ سڀ ڪجهه آهي، شايد توهان جو پلگ ان ڊفالٽ طور انسٽال نه ٿئي، پر جڏهن توهان md ايڪسٽينشن سان فائل ٺاهي، توهان کي ان کي ڊائونلوڊ ڪرڻ لاءِ چيو ويندو. پنهنجي IDEA ڊائون لوڊ ۽ ٻيهر شروع ڪريو.




7. مارڪ ڊائون درآمد ڪرڻ کان پوءِ اسان لکيو، ان کي IDEA ذريعي کوليو ۽ ضروري هجي ته ان کي ايڊٽ ڪيو. اھو اھو آھي جيڪو IDEA ذريعي ڏسڻ ۾ اچي ٿو:

   اسان زور ڀريون ٿا. پوءِ اسان ڏسون ٿا ته جڏهن ڪو پراجيڪٽ کوليو وڃي ٿو، ان بابت معلومات فوري طور تي لوڊ ٿي ويندي آهي، هي آهي اسان جي README.md:

   ھاڻي، جڏھن اسان بيج تي ڪلڪ ڪندا آھيون، اسان سڌو سنئون پروجيڪٽ اسيمبلي ڏانھن وڃو ۽ ڏسون ته اسان وٽ ڇا آھي ۽ ڪيئن.




8. مان ساڳيو ئي ڪندس JaCoCo برانچ لاءِ ڪوڊيڪوف بيج کي ظاهر ڪرڻ لاءِ، ڇاڪاڻ ته اسان وٽ اڃا تائين README.md ناهي. نتيجي طور، اسان وٽ هاڻي ٻه بيج آهن:

   ڪوڊڪوف ڪوڊ ڪوريج جو سيڪڙو ڏيکاري ٿو، ۽ اهو پڻ اسان کي ڪوڊيڪوف صفحي ڏانهن ريڊائريڪٽ ڪري سگهي ٿو ۽ تفصيلي ڪوڊ ڪوريج رپورٽ ڏيکاري ٿو.

مفيد لنڪس

• ڇا وڪي اسان کي مارڪ ڊائون بابت ٻڌائي ٿو.
• مارڪ ڊائون ايڊيٽرز ڊاريڪٽري ؛
• هاروپڊ جنهن کي مان سفارش ڪريان ٿو؛
• JetBrains ويب سائيٽ تي مارڪ ڊائون بابت ؛
• ساڳي JetBrains تي مارڪ ڊائون نيويگيٽر ؛
• بيج ۽ انھن جي باري ۾ سڀڪنھن شيء کي. هتي توهان ڪنهن به بيج جو انداز چونڊي سگهو ٿا ۽ ان کي پنهنجي لاءِ ترتيب ڏئي سگهو ٿا؛
• توهان جي اوپن سورس پروجيڪٽ کي ڪيئن اپڊيٽ ڪجي؟ هي مضمون به جواب ڏيندو ؛
• اڳيون مضمون

اچو ته منهنجي مضمونن جي سيريز کي اختصار ڪريون

1. اسان ڏٺو ته CI ڇا آهي، اهو ڇا لاءِ آهي ۽ ان کي ڪيئن استعمال ڪجي پهرين مضمون ۾ Continuous Integration بابت ؛
2. اسان CC سان گڏ راند ڪيو ۽ سمجھيو ته اھو ڇا آھي ۽ ڇو ان جي ضرورت آھي ٻئي مضمون ۾ ڪوڊ ڪوريج بابت ؛
3. ۽ هن آرٽيڪل ۾ اسان ڏٺو ته مارڪ ڊائون ڇا آهي، اهو ڇو ضروري آهي ۽ ان کي مؤثر طريقي سان ڪيئن استعمال ڪجي.

انهن ٽنهي ڊگهن مضمونن کي پڙهڻ لاءِ توهان سڀني جي مهرباني، مون کي اميد آهي ته اهي ڪارآمد هئا. متن ۾ غلطيون ۽ غلطيون ٿي سگهن ٿيون. توهان جي ڌيان لاء توهان سڀني جي مهرباني!