Markdown

Кайырлы күн, кесиптештер! Узакка созулган окуу сапарынан кийин ар бир адам жумуш берүүчүгө өзүнүн жемишин көрсөткүсү келет жана аларды эң мыкты, кесипкөй жагынан гана көрсөткүсү келет, туурабы? Мен ооба деп ойлойм. Демек, туура иштелип чыккан жана ишке ашырылган долбоордон тышкары, биз аны формалдаштыра бorшибиз керек. Жумуш берүүчү сиздин долбоордун codeунун баарын окуbyte, ал эмне жөнүндө жана ага эмне кирет? Бул макалада биз мурунку экөөнү жыйынтыктайбыз, атап айтканда: Үзгүлтүксүз интеграция жана codeду камтуу жана ачык булактуу долбоордун "алдыңкы" барагында биздин долбоордо эмнени колдонгонубузду жана ал эмнени билдирерин түшүнөлү. Бүгүн биз сиз менен Маркдаун жөнүндө сүйлөшөбүз, сүйүктүү суроолорубузду бериңиз: "Бул эмне?" жана "Эмне үчүн бул?", келгиле, ал кайда колдонулат жана аны менен кантип иштөө керектигин аныктап көрөлү. Ал тургай, бир мисал болот, биз аны ачык булактуу долбоорубузда ишке ашырабыз . Ошентип, кеттик!

"Markdown" деген эмне?

Сиз жана мен программист болгондуктан, биз дароо Google'га өтүп, биринчи Wiki шилтемесин ачабыз , анда мындай дейт: Markdown - эң окула турган жана түзөтүүгө оңой текст жазуу максатында түзүлгөн, бирок төмөнкүгө ылайыктуу өнүккөн басылмалар үчүн тилдерге айландыруу (HTML , Rich Text жана башкалар). Бул жерде, чынын айтсам, мен кошумчалай турган көп нерсе жок, мен бул дээрлик кемчorксиз түшүндүрмө деп ойлойм.

Эмне үчүн бизге бул "Markdown" керек?

Чынын айтсам, ансыз деле жаман эмес :D Бирок биздин максатты эстеп көрөлү: Үзгүлтүксүз интеграцияга ээ жана Codecov булагында Code Coverage статистикасы бар компетенттүү долбоордун шаблонун жазуу. Мен муну эмне үчүн айттым? Мындан тышкары, Markdown бизге бул ресурстардан маалыматтарды алууга жана маалыматтардын өзүн же бейджиктерди берүүгө мүмкүнчүлүк берет. Ар кайсы жерде чачылгандан көрө, бардыгын бир "титул" баракта кармоо ыңгайлуу, туурабы?

Кайда колдонулат?

GitHub'га жок дегенде бир жолу өзүнүн долбоорлорун жүктөгөн ар бир адам GitHub сизди README файлын түзүүгө чакыргысы келерин билет: Бул файлдын кеңейтorши кандай? Туура, Болт Маркдаунду билет! Белгилүү болгондой, бул файл көптөгөн форматтарга оңой туураланган жана бизге керектүү HTMLге айландырылат. Бирок келгиле, убактыбызды алалы жана аны дароо GitHub'ка кошууга шашпа.

Аны менен кантип иштөө керек?

Биринчиден, сиз байкагандай, биз аны түздөн-түз GitHub'ка кошо алабыз жана ал иштейт! Бирок, мисалы, биз ар дайым бир эле долбоорго кошуу керек эмес. Же, мисалы, биз аны кантип жаратканыбыз жөнүндө көбүрөөк ойлонгубуз келет. Бул жерде GitHub бизге ылайыктуу эмес. Жана жалпысынан, биз Markdown файлдарын GitHub'ка түртүү максатында гана түзө албайбыз. Экинчиден, биз аны түздөн-түз IDEA аркылуу түзө алабыз, бул биз жасай турган нерсе, бирок дароо эмес, эмне үчүн бизге бир кичинекей файлды жазуу үчүн күчтүү өнүктүрүү чөйрөсү керек? Бул жерде мен оңой жана оңой эмес, Markdown файл редакторлорунун каталогун карап чыгууну сунуштайм. Мен өзүм үчүн Haroopadды тандадым , ал абдан жөнөкөй, жеткorктүү, сиз жазып жаткан нерсеңизди заматта чагылдырат (IDEA да жасайт) жана синтаксиси бар. Редактор терезеси ушундай көрүнөт: Бул жерде мен долбоорлорумдун биринин даяр README.md файлын ачтым. Сол жакта чит баракчасы, оң жакта дисплей, борборунда текст. Баары абдан примитивдүү жана жөнөкөй. Сиз ошондой эле төш белгилерди көрө аласыз, алар жөнүндө биз жакында сүйлөшөбүз. Бул файлдарды жазуунун башка ыкмасын тандагандар - коркпогула, баары башкача болот графикалык интерфейс. Текст, синтаксис жана дисплей өзгөрүүсүз калат. Мисал Тапшырма абдан жөнөкөй: README.md камтыгандай кылып жазыңыз: долбоор жөнүндө маалымат (анын ичинде төш белгилер), долбоорду импорттоо жөнүндө маалымат, долбоорду ишке ашыруу жөнүндө маалымат, автордун байланыштары жөнүндө маалымат. Баары абдан жөнөкөй жана примитивдүү, мен буга чейин айткандай. Келгиле, бизнеске киришели.

1. Келгиле, аталышты жазалы - биздин долбоордун аталышы.

   Негизги жана эң чоң рубрика " # " хэш-операторунун жардамы менен түзүлүп , андан кийин аталыш жазылат. Биздин учурда:

   # ForJavaRushPublication

2. Андан кийин биз бир аз кичирээк аталышты жазабыз жана "Долбоор жөнүндө маалымат" деп жазабыз. Кичинекей аталыштын алдында көбүрөөк " # " бар:

   ## Information

   Анан долбоор боюнча маалымат жазабыз.

3. Биздин макалаларга шилтемелерди киргизели. Бул абдан жөнөкөй жасалат жана эгер сиз Haroopad колдонсоңуз, анда алдамчылык барагын териңиз жана шаблон өзү киргизилет. Синтаксис: " [text](url) ";

4. Бейджиктерди киргизели. Келгиле, бул жерде кененирээк карап көрөлү.

   Адегенде аларды сулуулук үчүн дасторкон түрүндө тизип алалы. 2 тилке жана 2 тилке болот. Синтаксис төмөнкүдөй болот:

   Жана натыйжа мындай болот:

   Андан кийин, биз бейджиктерге гипершилтемелерди кыстарабыз, бирок аларды кайдан алсак болот? Мен мурунку макалада Codecovту кайдан алсам болорун көрсөттүм, бирок кайсынысын алуу керектигин айткан жокмун. Бизде Markdown файлы бар болгондуктан, бизге Markdown Белгиси да керек:

   Аны көчүрүп алып, Маркdownдагы тилкеге ​​чаптаңыз. Бирок Codecov JaCoCo тармагында пайда болгонун, бирок мастерде эмес экенин унутпаңыз, андыктан аны кол менен оңдоого туура келет. Travis CI төш белгиси долбоордун аталышынын карама-каршысында кабыл алынат, мында куруу журналы:

   Биз төш белгини тандайбыз, андан кийин орнотуулар терезеси ачылат:

   Биз сөзсүз Markdown жана сизге керектүү фorалды тандайбыз. Мен эки бутак үчүн README.md жасайм, алар бир аз башкачараак болот, анткени мен Master бутагына Codecovду киргизе элекмин.




5. Бул долбоорду кантип импорттоо же клондоо боюнча маалымат жазалы. Мен муну кантип жасоону түшүндүрбөйм, бирок сиз аны менин README.md сайтымдан окуй аласыз. Долбоорубузда колдонгон технологиялар жөнүндө жазып, аларга шилтемелерди жайгаштырабыз. Ошентсе да, бул бorм берүү долбоору. Мейли, байланыш маалыматын жазып коёлу.




6. Биздин Markdown даяр. Болгону аны биздин долбоорго кошуу керек жана биз бүттүк. Бирок баары бир убакта эмес! Келгиле, IDEA ачалы, жана Плагиндерде биз Markdown колдоосуна ээ экениңизди текшеребиз:

   Менде Ultimate IDEA бар, андыктан менде баары бар, сиздин плагин демейки боюнча орнотулбашы мүмкүн, бирок сиз md кеңейтүүсү менен файл түзүп жатканда, сизден аны жүктөп алуу сунушталышы керек. IDEAңызды жүктөп алып, кайра иштетиңиз.




7. Биз жазган Markdown импорттоодон кийин, аны IDEA аркылуу ачып, керек болсо түзөтүңүз. Бул IDEA аркылуу көрүнөт:

   Биз түртүп жатабыз. Анан биз долбоорду ачып жатканда, ал жөнүндө маалымат дароо жүктөлүп жатканын көрөбүз , бул биздин README.md:

   Эми, биз төш белгини басканда, биз түз эле долбоордун жыйынына секирип, ал жерде эмне бар экенин жана кантип көрө алабыз.




8. Codecov төш белгисин көрсөтүү үчүн мен JaCoCo фorалы үчүн да ушундай кылам, анткени бизде али README.md жок. Натыйжада, бизде эки төш белги бар:

   Codecov codeдун камтылышынын пайызын көрсөтөт, ошондой эле ал бизди Codecov баракчасына багыттап, codeдун камтуусунун деталдаштырылган отчетун көрсөтө алат.

пайдалуу шилтемелер

• Wiki бизге Markdown жөнүндө эмне дейт;
• Markdown Editors Directory ;
• Мен сунуш кылган Haroopad ;
• JetBrains веб- сайтында Markdown жөнүндө ;
• Ошол эле JetBrains боюнча Markdown Navigator ;
• Белгилер жана алар жөнүндө бардыгы. Бул жерде сиз каалаган төш белгинин стorн тандап, аны өзүңүзгө ылайыкташтыра аласыз;
• Ачык булактуу долбооруңузду кантип жаңыртса болот? Бул макала да жооп берет ;
• Мурунку макала

Макалаларымдын сериясын кыскача баяндайлы

1. Үзгүлтүксүз интеграция жөнүндө биринчи макалада CI деген эмне, ал эмне үчүн жана аны кантип колдонсо болорун карап чыктык ;
2. Биз CC менен ойнодук жана бул эмне экенин жана эмне үчүн Code Coverage жөнүндө экинчи макалада түшүндүк ;
3. Жана бул макалада биз Markdown деген эмне, ал эмне үчүн керек жана аны кантип натыйжалуу колдонуу керек экенин карап чыктык.

Бул үч узун макаланы окуганыңыз үчүн бардыгыңызга рахмат, алар пайдалуу болду деп ишенем. Текстте каталар жана кемчorктер болушу мүмкүн. Көңүл бурганыңыздар үчүн рахмат!