Белгілеу

Қайырлы күн, әріптестер! Ұзақ оқу сапарынан кейін әркім жұмыс берушіге өз жемісін көрсеткісі келеді және оларды тек жақсы, кәсіби жағынан көрсеткісі келеді, солай емес пе? Мен Иә деп ойлаймын. Сондықтан дұрыс жобаланып, жүзеге асырылған жобамен қатар, оны рәсімдей білуіміз керек. Жұмыс беруші жобаның не туралы екенін және оған не кіретінін түсіну үшін барлық жоба codeын оқымайды? Бұл мақалада біз алдыңғы екеуін қорытындылаймыз, атап айтқанда: Үздіксіз интеграция және codeты қамту және ашық бастапқы жобаның «алдыңғы» парағында жобамызда не пайдаланғанымызды және оның нені білдіретінін түсінейік. Бүгін біз сіздермен Маркдаун туралы сөйлесеміз, сүйікті сұрақтарымызды қоямыз: «Бұл не?» және «Бұл неліктен?», оның қайда қолданылатынын және онымен қалай жұмыс істеу керектігін анықтайық. Тіпті мысал болады, біз оны ашық бастапқы жобамызда жүзеге асырамыз . Ендеше, кеттік!

«Markdown» дегеніміз не?

Сіз және мен бағдарламашы болғандықтан, біз бірден Google-ге өтіп, Wiki-дің бірінші сілтемесін ашамыз , онда былай делінген: Markdown – ең оқылатын және өңдеуге оңай мәтін жазу мақсатымен жасалған, бірақ мыналар үшін қолайлы кеңейтілген жарияланымдар үшін тілдерге түрлендіру (HTML , Rich Text және т.б.). Бұл жерде, шынымды айтсам, менде көп нәрсе жоқ, менің ойымша, бұл өте жақсы түсініктеме.

Бұл «Маркdown» бізге не үшін қажет?

Шынымды айтсам, онсыз да жаман емес :D Бірақ біздің мақсатымызды еске түсірейік: Үздіксіз интеграциясы бар және Codecov ресурсында codeты қамту статистикасы бар сауатты жоба үлгісін жазу. Мен мұны неге айттым? Сонымен қатар, Markdown бізге осы ресурстардан деректерді алуға және деректердің өзін немесе бізді осы ақпаратты алу үшін қажет жерге бағыттайтын бейдждерді беруге мүмкіндік береді. Әр жерде шашыраңқы емес, бір «титул» бетінде барлығы ыңғайлы, солай емес пе?

Ол қайда қолданылады?

GitHub-қа кем дегенде бір рет жобаларын жүктеп салған кез келген адам GitHub сізді README файлын жасауға шақырғысы келетінін біледі: Бұл файлдың кеңейтімі қандай? Дұрыс, Болт Маркдаунды біледі ! Біз білетіндей, бұл файл көптеген форматтарға оңай реттеледі және бізге қажет HTML-ге түрлендіріледі. Бірақ уақытымызды алайық және оны бірден GitHub-қа қосуға асықпаңыз.

Онымен қалай жұмыс істеу керек?

Біріншіден, сіз байқаған боларсыз, біз оны тікелей GitHub-қа қоса аламыз және ол жұмыс істейді! Бірақ біз оны әрқашан бір жобаға қосудың қажеті жоқ, мысалы. Немесе, мысалы, біз оны қалай жасайтынымыз туралы көбірек ойланғымыз келеді. Бұл жерде GitHub енді бізге жарамайды. Жалпы, біз Markdown файлдарын GitHub-қа итеру үшін ғана емес жасай аламыз. Екіншіден, біз оны тікелей IDEA арқылы жасай аламыз, бұл біз дәл солай істейміз, бірақ бірден емес, неге бізге бір шағын файлды жазу үшін қуатты әзірлеу ортасы қажет? Мұнда мен оңай және оңай емес Markdown файл редакторларының каталогын шолуды ұсынамын. Мен өзім үшін Haroopad таңдадым , ол өте қарапайым, қол жетімді, сіз жазып жатқан нәрсені бірден көрсетеді (IDEA да жасайды) және синтаксистік кеңесі бар. Редактор терезесі осылай көрінеді: Мұнда мен өз жобаларымның бірінің дайын README.md файлын аштым. Сол жақта хит парағы, оң жақта дисплей, ортасында мәтін бар. Барлығы өте қарапайым және қарапайым. Сіз сондай-ақ жақын арада айтатын белгілерді көре аласыз. Бұл файлдарды жазудың басқа әдісін таңдайтындар - алаңдамаңыз, бәрі басқаша болады графикалық интерфейс. Мәтін, синтаксис және дисплей өзгеріссіз қалады. Мысал Тапсырма өте қарапайым: README.md деп жазыңыз, сонда ол мыналарды қамтиды: жоба туралы ақпарат (соның ішінде бейдждер), жобаны импорттау туралы ақпарат, жобаны жүзеге асыру туралы ақпарат, автордың байланыстары туралы ақпарат. Жоғарыда айтқанымдай, бәрі өте қарапайым және қарапайым. Іске кірісейік.

1. Тақырыпты жазайық - жобамыздың атауы.

   Негізгі және ең үлкен тақырып хэш-оператор « # » көмегімен жасалады , содан кейін тақырып жазылады. Біздің жағдайда:

   # ForJavaRushPublication

2. Содан кейін біз сәл кішірек тақырып жазамыз және біз «Жоба туралы ақпарат» жазамыз. Кіші тақырыптың алдында көбірек " # " болады:

   ## Information

   Сосын жоба туралы мәлімет жазамыз.

3. Мақалаларымызға сілтемелер енгізейік. Бұл өте қарапайым орындалады және Haroopad қолданбасын пайдалансаңыз, алдау парағын теріңіз, сонда үлгі өзі енгізіледі. Синтаксис: " [text](url) ";

4. Бейдждерді салайық. Мұнда толығырақ қарастырайық.

   Алдымен оларды әдемілік үшін үстел түрінде орналастырайық. 2 баған және 2 баған болады. Синтаксис келесідей болады:

   Және нәтиже келесідей болады:

   Содан кейін біз танымбелгілерге гиперсілтемелер енгіземіз, бірақ оларды қайдан алуға болады? Мен алдыңғы мақалада Codecov-ты қайдан алуға болатынын көрсеттім, бірақ қайсысын алу керектігін айтқан жоқпын. Бізде Markdown файлы болғандықтан, бізге Markdown белгісі де қажет:

   Тек оны көшіріп алып, Markdown ішіндегі бағанға қойыңыз. Бірақ Codecov JaCoCo фorалында пайда болғанын, бірақ шеберде емес екенін ұмытпаңыз, сондықтан оны қолмен түзетуге тура келеді. Travis CI белгісі жоба атауына тікелей қарама-қарсы қабылданады, мұнда құрастыру журналы:

   Біз белгішені таңдаймыз, содан кейін параметрлер терезесі ашылады:

   Біз міндетті түрде Markdown және сізге қажет фorалды таңдаймыз. Мен екі тармақ үшін README.md жасаймын және олар сәл өзгеше болады, өйткені мен әлі де негізгі фorалда Codecov қолданбадым.




5. Осы жобаны импорттау немесе клондау туралы ақпаратты жазайық. Мен мұны қалай жасау керектігін түсіндірмеймін, бірақ оны менің README.md сайтымнан оқи аласыз. Біз өз жобамызда пайдаланған технологиялар туралы, оларға сілтемелер қою арқылы жазамыз. Дегенмен, бұл білім беру жобасы. Ал, байланыс ақпаратын жазып алайық.




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 навигаторы ;
• Белгілер және олар туралы бәрі. Мұнда сіз кез келген бейдждің стилін таңдай аласыз және оны өзіңізге баптай аласыз;
• Ашық бастапқы жобаны қалай жаңартуға болады? Бұл мақала да жауап береді ;
• Алдыңғы мақала

Мақалаларымның топтамасын қорытындылайық

1. Үздіксіз интеграция туралы бірінші мақалада CI дегеніміз не, ол не үшін және оны қалай пайдалану керектігін қарастырдық ;
2. Біз CC-мен ойнадық және оның не екенін және codeты қамту туралы екінші мақалада оның не үшін қажет екенін түсіндік ;
3. Бұл мақалада біз Markdown деген не екенін, ол не үшін қажет екенін және оны қалай тиімді пайдалану керектігін қарастырдық.

Осы үш ұзақ мақаланы оқығаныңыз үшін барлығыңызға рахмет, олар пайдалы болды деп үміттенемін. Мәтінде қателер мен олқылықтар болуы мүмкін. Назарларыңызға барлығыңызға рахмет!