Markdown

Xayrli kun, hamkasblar! Uzoq o'rganish sayohatidan so'ng, har bir kishi ish beruvchiga o'z mevalarini ko'rsatishni va ularni faqat eng yaxshi, professional tomondan ko'rsatishni xohlaydi, to'g'rimi? Menimcha ha. Shuning uchun, to'g'ri ishlab chiqilgan va amalga oshirilgan loyihadan tashqari, biz uni rasmiylashtira olishimiz kerak. Ish beruvchi sizning loyihangiz nima haqida ekanligini va unga nima kiritilganligini tushunish uchun barcha loyiha kodingizni o'qimaydi? Ushbu maqolada biz nihoyat oldingi ikkitasini umumlashtiramiz, ya'ni: Uzluksiz integratsiya va kodni qamrab olish va ochiq manbali loyihaning "old" varag'ida biz loyihamizda nimani ishlatganimizni va u nimani anglatishini tushunamiz. Bugun biz siz bilan Markdown haqida gaplashamiz, sevimli savollarimizni beramiz: "Bu nima?" va "Nima uchun bu?", keling, u qaerda ishlatilishini va u bilan qanday ishlashni aniqlaylik. Hatto misol bo'ladi, biz uni ochiq manbali loyihamizda amalga oshiramiz . Xo'sh, ketaylik!

"Markdown" nima?

Siz va men dasturchi bo'lganimiz sababli, biz darhol Google-ga o'tamiz va birinchi Wiki havolasini ochamiz : Markdown - bu eng o'qiladigan va tahrirlanishi oson matnni yozish maqsadida yaratilgan engil belgilash tili. ilg'or nashrlar uchun tillarga aylantirish (HTML , Rich Text va boshqalar). Bu erda, rostini aytsam, qo'shimcha qiladigan narsam yo'q, menimcha, bu deyarli mukammal tushuntirish.

Nima uchun bizga bu "Markdown" kerak?

Rostini aytsam, unsiz ham yomon emas :D Ammo maqsadimizni eslaylik: allaqachon uzluksiz integratsiyaga ega bo'lgan va Codecov resursida Code Coverage statistikasiga ega bo'lgan vakolatli loyiha shablonini yozish. Nega men buni eslatib o'tdim? Bundan tashqari, Markdown bizga ushbu resurslardan ma'lumotlarni olish va ma'lumotlarning o'zi yoki bizni ushbu ma'lumotni olishimiz kerak bo'lgan joyga yo'naltiradigan nishonlarni taqdim etish imkonini beradi. Har bir narsaning turli joylarda tarqalib ketganidan ko'ra, bitta "sarlavha" sahifasida bo'lishi qulay, shunday emasmi?

U qayerda ishlatiladi?

GitHub-ga hech bo'lmaganda bir marta o'z loyihalarini yuklagan har bir kishi biladiki, GitHub sizni README faylini yaratishga taklif qilmoqchi: bu faylning kengaytmasi nima? To'g'ri, Bolt Markdownni biladi! Biz allaqachon bilganimizdek, bu fayl juda oson ko'plab formatlarga moslashtiriladi va bizga kerak bo'lgan HTMLga aylantiriladi. Ammo keling, vaqt ajrataylik va uni darhol GitHub-ga qo'shishga shoshilmang.

U bilan qanday ishlash kerak?

Birinchidan, siz sezganingizdek, biz uni to'g'ridan-to'g'ri GitHub-ga qo'shishimiz mumkin va u ishlaydi! Lekin biz har doim ham, masalan, faqat bitta loyihaga qo'shishimiz shart emas. Yoki, masalan, biz uni qanday yaratishimiz haqida ko'proq o'ylashni xohlaymiz. Va bu erda GitHub endi biz uchun mos emas. Va umuman olganda, biz Markdown fayllarini nafaqat ularni GitHub-ga surish uchun yaratishimiz mumkin. Ikkinchidan, biz uni to'g'ridan-to'g'ri IDEA orqali yaratishimiz mumkin, bu biz aynan shunday qilamiz, lekin darhol emas, nega bitta kichik faylni yozish uchun kuchli rivojlanish muhiti kerak? Bu erda men Markdown fayl muharrirlarining oson va unchalik oson bo'lmagan katalogini ko'rib chiqishni tavsiya qilaman. Men o'zim uchun Haroopad ni tanladim , u juda sodda, foydalanish mumkin, siz yozayotgan narsaning bir zumda tasviriga ega (IDEA ham qiladi) va sintaktik maslahatga ega. Tahrirlovchi oynasi shunday ko'rinadi: Bu erda men loyihalarimdan birining tayyor README.md ni ochdim. Chapda cheat varaq, o'ngda displey, markazda matn. Hamma narsa juda ibtidoiy va oddiy. Shuningdek, nishonlarni ham ko'rishingiz mumkin, ular haqida tez orada gaplashamiz. Ushbu fayllarni yozishning boshqa usulini tanlaganlar - vahima qo'ymang, barchasi grafik interfeysdan farq qiladi. Matn, sintaksis va displey o'zgarishsiz qoladi. Misol Vazifa juda oddiy: README.md-ni shunday yozingki, unda quyidagilar mavjud: loyiha haqida ma'lumot (jumladan, nishonlar), loyihani import qilish to'g'risidagi ma'lumotlar, loyihani amalga oshirish to'g'risidagi ma'lumotlar, muallifning aloqalari haqidagi ma'lumotlar. Men aytganimdek, hamma narsa juda oddiy va ibtidoiy. Keling, biznesga kirishaylik.

1. Keling, sarlavha yozamiz - loyihamiz nomi.

   Asosiy va eng katta sarlavha “ # ” xesh-operatori yordamida yaratiladi va keyin sarlavha yoziladi. Bizning holatda:

   # ForJavaRushPublication

2. Keyin biroz kichikroq sarlavha yozamiz va "Loyiha haqida ma'lumot" yozamiz. Kichikroq sarlavha oldidan ko'proq " # " qo'yilgan:

   ## Information

   Va keyin biz loyiha haqida ma'lumot yozamiz.

3. Keling, maqolalarimizga havolalar kiritaylik. Bu juda sodda tarzda amalga oshiriladi va agar siz Haroopad-dan foydalansangiz, shunchaki cheat varaqni kiriting va shablon o'zi kiritiladi. Sintaksis: " [text](url) ";

4. Keling, nishonlarni joylashtiramiz. Keling, bu erda batafsilroq ko'rib chiqaylik.

   Birinchidan, ularni go'zallik uchun stol shaklida tashkil qilaylik. 2 ta ustun va 2 ta ustun bo'ladi. Sintaksis quyidagicha ko'rinadi:

   Va natija quyidagicha bo'ladi:

   Keyinchalik, biz nishonlarimizga giperhavolalarni joylashtiramiz, lekin ularni qayerdan olishimiz mumkin? Men oldingi maqolada Codecov-ni qaerdan olish kerakligini ko'rsatdim, ammo qaysi birini olish kerakligini aytmadim. Bizda Markdown fayli borligi sababli, Markdown nishoni ham kerak:

   Uni nusxalash va Markdown-dagi ustunga joylashtirish kifoya. Ammo unutmangki, Codecov JaCoCo filialida paydo bo'lgan, lekin masterda emas, shuning uchun uni qo'lda tuzatishingiz kerak bo'ladi. Travis CI nishoni to'g'ridan-to'g'ri loyiha nomining qarshisida olinadi, bu erda qurilish jurnali:

   Biz nishonni tanlaymiz, keyin sozlamalar oynasi ochiladi:

   Biz, albatta, Markdownni va sizga kerak bo'lgan filialni tanlaymiz. Men README.md ni ikkita filial uchun yarataman va ular biroz farq qiladi, chunki men hali Codecov-ni master filialiga kiritmaganman.




5. Keling, ushbu loyihani import qilish yoki klonlash haqida ma'lumot yozamiz. Buni qanday qilishni tushuntirmayman, lekin siz uni mening README.md da o'qishingiz mumkin. Biz loyihamizda foydalangan texnologiyalar haqida yozamiz, ularga havolalar joylashtiramiz. Shunga qaramay, bu ta'lim loyihasidir. Xo'sh, keling, kontakt ma'lumotlarini yozamiz.




6. Bizning Markdown tayyor. Biz qilishimiz kerak bo'lgan narsa uni loyihamizga qo'shish va biz tugatdik. Lekin hammasi birdan emas! Keling, IDEA-ni ochamiz va plaginlarda sizda Markdown yordami mavjudligini tekshiramiz:

   Menda Ultimate IDEA bor, shuning uchun menda hamma narsa bor, sizning plaginingiz sukut bo'yicha o'rnatilmagan bo'lishi mumkin, lekin siz md kengaytmali faylni yaratganingizda, uni yuklab olishingiz so'ralishi kerak. IDEA-ni yuklab oling va qayta ishga tushiring.




7. Biz yozgan Markdownni import qilgandan so'ng, uni IDEA orqali oching va kerak bo'lganda tahrirlang. Bu IDEA orqali shunday ko'rinadi:

   Biz surish qilamiz. Keyin biz loyihani ochganda, u haqidagi ma'lumotlar darhol yuklanishini ko'ramiz , bu bizning README.md:

   Endi nishonni bosganimizda, biz to'g'ridan-to'g'ri loyiha yig'ilishiga o'tishimiz va u erda nima borligini va qandayligini ko'rishimiz mumkin.




8. Codecov nishonini namoyish qilish uchun JaCoCo filiali uchun ham xuddi shunday qilaman, chunki bizda hali README.md mavjud emas. Natijada, bizda ikkita nishon bor:

   Codecov kodni qamrab olish foizini ko'rsatadi va u bizni Codecov sahifasiga yo'naltirishi va kodni qamrab olish bo'yicha batafsil hisobotni ko'rsatishi mumkin.

foydali havolalar

• Wiki bizga Markdown haqida nima deydi;
• Markdown Editors Directory ;
• Men tavsiya qiladigan Haroopad ;
• JetBrains veb- saytida Markdown haqida ;
• Xuddi shu JetBrains-da Markdown Navigator ;
• Nishonlar va ular haqida hamma narsa. Bu erda siz har qanday nishonning uslubini tanlashingiz va uni o'zingiz uchun sozlashingiz mumkin;
• Ochiq kodli loyihangizni qanday yangilash mumkin? Bu maqola ham javob beradi ;
• Oldingi maqola

Keling, maqolalarim turkumini umumlashtiraylik

1. Biz CI nima ekanligini, nima uchun ekanligini va undan qanday foydalanishni Uzluksiz integratsiya haqidagi birinchi maqolada ko'rib chiqdik ;
2. Biz CC bilan o'ynadik va bu nima ekanligini va nima uchun kodni qamrab olish haqidagi ikkinchi maqolada tushundik ;
3. Va ushbu maqolada biz Markdown nima ekanligini, nima uchun kerakligini va undan qanday samarali foydalanishni ko'rib chiqdik.

Ushbu uchta uzun maqolani o'qiganingiz uchun barchangizga rahmat, ular foydali bo'ldi deb umid qilaman. Matnda xato va kamchiliklar bo'lishi mumkin. E'tiboringiz uchun barchangizga rahmat!