Markdown

Günüňiz haýyrly, kärdeşler! Uzakly okuwdan soň, her kim iş berijä öz miwelerini görkezmek we diňe iň oňat, hünär tarapdan görkezmek isleýär, şeýlemi? Hawa diýip pikir edýärin. Şonuň üçin dogry düzülen we ýerine ýetirilen taslama goşmaça, ony resmileşdirmegi başarmaly. Iş beriji, onuň nämedigine we nämäniň içine girýändigine düşünmek üçin ähli taslama koduňyzy okamaz? Bu makalada, ahyrky ikisini jemläris, ýagny: Üznüksiz integrasiýa we kod örtügi , we açyk çeşmeli taslamanyň “öň” sahypasynda taslamamyzda näme ulanandygymyzy we nämäni aňladýandygyna düşüneliň. Bu gün Markdown hakda size gürleşeris, iň gowy görýän soraglarymyzy bereris: "Bu näme?" we "Näme üçin beýle?", geliň nirede ulanylýandygyny we onuň bilen nähili işlemelidigini anyklalyň. Hatda bir mysal bolar, ony açyk çeşmeli taslamamyzda durmuşa geçireris . Geliň!

"Markdown" näme?

Siz we men programmist bolanymyz üçin derrew Google-a baryp, ilkinji Wiki baglanyşygyny açarys , şeýle diýilýär: Markdown iň okalýan we redaktirläp bolýan teksti ýazmak maksady bilen döredilen, ýöne amatly ösen neşirler üçin dillere öwürmek (HTML, baý tekst we başgalar). Ynha, dogrymy aýtsam, goşjak zadym ýok, meniň pikirimçe bu gaty gowy düşündiriş.

Näme üçin bu "Markdown" gerek?

Dogrusyny aýtsak, onsuzam erbet däl: D Butöne maksadymyzy ýatdan çykaralyň: eýýäm üznüksiz integrasiýa we Codecov çeşmesinde kod örtügi statistikasy bolan başarnykly taslama şablonyny ýazmak. Näme üçin muny ýatladym? Mundan başga-da, Markdown bu çeşmelerden maglumatlary almaga we maglumatlary özi bilen üpjün etmäge ýa-da bu maglumatlary nireden almalydygymyzy gönükdirjek nyşanlary bermäge mümkinçilik berer. Dürli ýerlere ýaýramak däl-de, hemme zady bir “at” sahypasynda saklamak amatly, şeýlemi?

Ol nirede ulanylýar?

Taslamalarynyň haýsydyr birini GitHub-a ýüklän adam, iň bolmanda bir gezek GitHub-yň sizi README faýly döretmäge çagyrmak isleýändigini bilýär: Bu faýlyň giňelmesi näme? Dogry, Bolt Markdown-y bilýär! Öň bilşimiz ýaly, bu faýl köp formatlara aňsatlyk bilen sazlanýar we zerur HTML-e öwrülýär. Let'söne geliň wagtymyzy alalyň we derrew GitHub-a goşmaga howlukmaň.

Munuň bilen nädip işlemeli?

Ilki bilen, üns beren bolmagyňyz mümkin, ony göni GitHub-a goşup bileris we işlär! Emma, ​​elmydama diňe bir taslama goşmak hökman däl. Ora-da mysal üçin, ony nädip döredýändigimiz hakda has köp pikir etmek isleýäris. Ine, GitHub indi biziň üçin amatly däl. Umuman aýdanyňda, Markdown faýllaryny diňe GitHub-a iteklemek maksady bilen döredip bileris. Ikinjiden, IDEA-nyň üsti bilen gönüden-göni döredip bileris, bu edil ediljek zadymyz, ýöne derrew däl, bir kiçijik faýl ýazmak üçin güýçli ösüş gurşawy gerekmi? Bu ýerde Markdown faýl redaktorlarynyň katalogyna göz aýlamagy maslahat berýärin . Özüm üçin “Haroopad” -y saýladym , bu gaty ýönekeý, elýeterli, ýazýan zatlaryňyzy derrew görkezýär (IDEA hem edýär) we sintaksis yşaraty bar. Redaktor penjiresiniň görnüşi: Ine, taslamalarymyň biriniň taýýar README.md açdym. Çep tarapda aldaw sahypasy, sagda displeý, ortasynda tekst bar. Hemme zat gaty ýönekeý we ýönekeý. Şeýle hem gysga wagtda gürleşjek nyşanlary görüp bilersiňiz. Bu faýllary ýazmagyň başga usulyny saýlanlar - gorkmaň, üýtgeşik zat grafiki interfeýsdir. Tekst, sintaksis we displeý üýtgemez. Mysal Taslama gaty ýönekeý: öz içine alýan görnüşde README.md ýazyň: taslama barada maglumatlar (nyşanlary goşmak bilen), taslama importy baradaky maglumatlar, taslamanyň durmuşa geçirilişi baradaky maglumatlar, awtoryň aragatnaşyklary baradaky maglumatlar. Hemme zat, öňem aýdyşym ýaly gaty ýönekeý we ýönekeý. Geliň, işe gireliň.

1. Ady - taslamamyzyň ady ýazalyň.

   Esasy we iň uly sözbaşy " # " hash operatorynyň kömegi bilen döredilýär we soňra ady ýazylýar. Biziň ýagdaýymyzda:

   # ForJavaRushPublication

2. Soň biraz kiçi at ýazarys we "Taslama maglumatlary" ýazarys. Has kiçi sözbaşy has köp " # " -den öň:

   ## Information

   Soň bolsa taslama barada maglumat ýazarys.

3. Makalalarymyza baglanyşyk goýalyň. Bu gaty ýönekeý ýerine ýetirilýär we “Haroopad” -y ulanýan bolsaňyz, diňe aldaw sahypasyny ýazyň we şablonyň özi giriziler. Sintaksis: " [tekst] (url) ";

4. Nyşanlary goýalyň. Geliň, şu ýere has içgin seredeliň.

   Ilki bilen gözellik üçin olary stol görnüşinde tertipläliň. 2 sütün we 2 sütün bolar. Sintaksis şuňa meňzeş bir zat görüner:

   Netije şeýle bolar:

   Ondan soň, nyşanlarymyza giperlinkleri goýarys, ýöne nireden alyp bileris? Öňki makalada Kodekowy nireden almalydygyny görkezipdim, ýöne haýsysyny almalydygyny aýtmadym. Markdown faýlymyz bolansoň, Markdown nyşany hem gerek:

   Diňe göçürip, Markdown-daky sütüne goýuň. Codeöne kodekowyň JaCoCo şahamçasynda peýda bolandygyny ýatdan çykarmaň, ýöne ussat däl, şonuň üçin ony el bilen düzetmeli bolarsyňyz. “Travis CI Badge”, gurluşyk gündeliginiň ýerleşýän ýerinde taslamanyň adynyň garşysynda alynýar:

   Nyşany saýlaýarys, soňra sazlamalar penjiresi açylýar:

   Markdown we size gerek şahany hökman saýlaýarys. Iki şaha üçin README.md ýasaryn, olar birneme üýtgeşik bolar, sebäbi men entek baş şahada Codecov-y durmuşa geçirmedim.




5. Geliň, bu taslamany nädip import etmeli ýa-da klonlamalydygy barada maglumat ýazalyň. Muny nädip etmelidigini düşündirip bilmerin, ýöne ony README.md-de okap bilersiňiz. Taslamamyzda ulanan tehnologiýalarymyz hakda, olara baglanyşyk goýarys. Muňa garamazdan, bu bilim taslamasy. Geliň, aragatnaşyk maglumatlary ýazalyň.




6. Markdown taýýar. Biziň etmeli zadymyz, ony taslamamyza goşmak we tamamladyk. Allöne birbada däl! IDEA-ny açalyň we Pluginlerde Markdown goldawynyň bardygyny barlaýarys:

   Ultimate IDEA bar, şonuň üçin mende hemme zat bar, pluginiňiz adaty ýagdaýda gurulman biler, ýöne md giňeltmesi bilen bir faýl döredeniňizde, ony göçürip almaly bolarsyňyz. IDEA-ny göçürip alyň.




7. Markdown ýazanymyzdan soň, IDEA arkaly açyň we zerur bolsa redaktirläň. IDEA-nyň üsti bilen şeýle görünýär:

   Biz itekleýäris. Soňra bir taslama açylanda, ol hakda maglumatlaryň derrew ýüklenýändigini görýäris , bu biziň README.md:

   Indi nyşany basanymyzda göni taslama ýygnagyna böküp bileris we ol ýerde nämäniň bardygyny we nädip bardygyny görüp bileris.




8. Kodekow nyşanyny görkezmek üçin JaCoCo şahamçasy üçinem şony ederin, sebäbi entek README.md ýok. Netijede, indi iki nyşanymyz bar:

   Kodekow kod gurşawynyň göterimini görkezýär we bizi Kodekow sahypasyna gönükdirip we kod barada jikme-jik hasabat görkezip biler.

peýdaly baglanyşyklar

• Wiki- iň Markdown hakda aýdýanlary ;
• Markdown redaktorlary katalogy ;
• Men maslahat berýän Haroopad ;
• JetBrains web sahypasyndaky Markdown hakda ;
• Şol bir JetBrains-de Markdown Navigator ;
• Nyşanlar we olar hakda hemme zat. Bu ýerde islendik nyşanyň stilini saýlap bilersiňiz we ony özüňiz düzüp bilersiňiz;
• Açyk çeşmeli taslamaňyzy nädip täzelemeli? Bu makala hem jogap berer ;
• Öňki makala

Geliň, makalalarymyň tapgyryny jemläliň

1. CI-iň nämedigini, onuň nämedigini we üznüksiz integrasiýa baradaky birinji makalada nädip ulanmalydygyna göz aýladyk ;
2. “CC” bilen oýnadyk we onuň nämedigini we “Code Coverage” baradaky ikinji makalada näme üçin zerurdygyna düşündik ;
3. Bu makalada Markdown-yň nämedigini, näme üçin zerurdygyny we ony nädip netijeli ulanmalydygyna göz aýladyk.

Bu üç uzyn makalany okanyňyz üçin hemmäňize sag bolsun aýdýaryn, peýdaly bolar diýip umyt edýärin. Tekstde ýalňyşlyklar we ýalňyşlyklar bolup biler. Üns bereniňiz üçin hemmäňize sag bolsun aýdýaryn!