Markdown

Gününüz xeyir, həmkarlar! Uzun bir öyrənmə səyahətindən sonra hər kəs işəgötürənə öz bəhrəsini göstərmək və yalnız ən yaxşı, peşəkar tərəfdən göstərmək istəyir, elə deyilmi? Məncə bəli. Ona görə də düzgün tərtib olunmuş və həyata keçirilən layihə ilə yanaşı, onu rəsmiləşdirməyi də bacarmalıyıq. İşəgötürən onun nə haqqında olduğunu və ona nə daxil olduğunu başa düşmək üçün bütün layihə kodunuzu oxumayacaq? Bu yazıda, nəhayət, əvvəlki ikisini ümumiləşdirəcəyik, yəni: Davamlı İnteqrasiya və Kod Əhatəsi və gəlin açıq mənbəli layihənin “ön” vərəqində layihəmizdə nədən istifadə etdiyimizi və onun nəyi təmsil etdiyini başa düşək. Bu gün sizinlə Markdown haqqında danışacağıq, sevimli suallarımızı verəcəyik: "Bu nədir?" və "Niyə belədir?", gəlin onun harada istifadə edildiyini və onunla necə işlədiyini anlayaq. Hətta bir nümunə də olacaq, onu açıq mənbə layihəmizdə həyata keçirəcəyik . Beləliklə, gedək!

"Markdown" nədir?

Siz və mən proqramçı olduğumuza görə, biz dərhal Google-a gedəcəyik və ilk Wiki linkini açacağıq ki, burada deyilir: Markdown ən oxunaqlı və asan redaktə edilə bilən mətni yazmaq məqsədi ilə yaradılmış, lakin aşağıdakılar üçün uyğun olan yüngül işarələmə dilidir. qabaqcıl nəşrlər üçün dillərə çevrilmə (HTML , Rich Text və s.). Düzünü desəm, əlavə edəcəyim çox şey yoxdur, düşünürəm ki, bu, demək olar ki, mükəmməl bir izahatdır.

Bu "Markdown" nəyə lazımdır?

Düzünü desəm, onsuz da pis deyil :D Ancaq məqsədimizi xatırlayaq: artıq Davamlı İnteqrasiyaya malik olan və Codecov resursunda Code Coverage statistikası olan səlahiyyətli layihə şablonu yazmaq. Bunu niyə qeyd etdim? Bundan əlavə, Markdown bizə bu resurslardan məlumat götürməyə və məlumatların özünü və ya bu məlumatı əldə etmək üçün bizə lazım olan yerə yönləndirəcək nişanları təqdim etməyə imkan verəcək. Müxtəlif yerlərə səpələnməkdənsə, hər şeyin bir "başlıq" səhifəsində olması rahatdır, elə deyilmi?

Harada istifadə olunur?

Layihələrindən hər hansı birini ən azı bir dəfə GitHub-a yükləyən hər kəs bilir ki, GitHub israrla sizi README faylı yaratmağa dəvət etmək istəyir: Bu faylın uzantısı nədir? Doğrudur, Bolt Markdown-u tanıyır ! Artıq bildiyimiz kimi, bu fayl çox asanlıqla bir çox formata uyğunlaşdırılır və bizə lazım olan HTML-yə çevrilir. Ancaq gəlin vaxtımızı alaq və onu dərhal GitHub-a əlavə etməyə tələsməyək.

Bununla necə işləmək olar?

Birincisi, fərq etdiyiniz kimi, biz onu birbaşa GitHub-a əlavə edə bilərik və o işləyəcək! Ancaq biz həmişə onu yalnız bir layihəyə əlavə etməli deyilik, məsələn. Və ya məsələn, onu necə yaratdığımız haqqında daha çox düşünmək istəyirik. Və burada GitHub artıq bizim üçün uyğun deyil. Və ümumiyyətlə, biz Markdown fayllarını təkcə onları GitHub-a itələmək məqsədilə yarada bilərik. İkincisi, biz onu birbaşa IDEA vasitəsi ilə yarada bilərik, bu, bizim edəcəyimiz şeydir, lakin dərhal deyil, ona görə ki, bir kiçik fayl yazmaq üçün nə üçün güclü inkişaf mühitinə ehtiyacımız var? Burada asan və o qədər də asan olmayan Markdown fayl redaktorlarının kataloquna baxmağı məsləhət görürəm . Özüm üçün Haroopad-ı seçdim, o, çox sadədir, əlçatandır, yazdıqlarınızı dərhal təqdim edir (IDEA da edir) və sintaksis göstərişinə malikdir. Redaktor pəncərəsi belə görünür: Burada layihələrimdən birinin hazır README.md-ni açdım. Solda fırıldaqçı vərəq, sağda displey, mərkəzdə mətn var. Hər şey çox primitiv və sadədir. Siz həmçinin nişanları da görə bilərsiniz, onlar haqqında bir azdan danışacağıq. Bu faylları yazmağın fərqli yolunu seçənlər - narahat olmayın, fərqli olacaq hər şey qrafik interfeysdir. Mətn, sintaksis və displey dəyişməz qalacaq. Nümunə Tapşırıq çox sadədir: README.md-ni elə yazın ki, o, özündə ehtiva etsin: layihə haqqında məlumat (nişanlar daxil olmaqla), layihənin idxalı haqqında məlumat, layihənin həyata keçirilməsi haqqında məlumat, müəllifin əlaqələri haqqında məlumat. Artıq dediyim kimi, hər şey çox sadə və primitivdir. Gəlin işə başlayaq.

1. Başlıq yazaq - layihəmizin adını.

   Əsas və ən böyük başlıq " # " hash operatorundan istifadə etməklə yaradılır və sonra başlıq yazılır. Bizim vəziyyətimizdə:

   # ForJavaRushPublication

2. Sonra bir az daha kiçik bir başlıq yazacağıq və "Layihə məlumatı" yazacağıq. Kiçik başlıqdan əvvəl daha çox " # " var:

   ## Information

   Və sonra layihə haqqında məlumat yazacağıq.

3. Məqalələrimizə keçidlər daxil edək. Bu, çox sadə şəkildə edilir və Haroopad istifadə edirsinizsə, sadəcə olaraq fırıldaqçı vərəqini yazın və şablon özü daxil ediləcək. Sintaksis belədir: " [text](url) ";

4. Nişanları daxil edək. Gəlin bura daha yaxından nəzər salaq.

   Əvvəlcə onları gözəllik üçün süfrə şəklində təşkil edək. 2 sütun və 2 sütun olacaq. Sintaksis bu kimi görünəcək:

   Və nəticə belə olacaq:

   Sonra nişanlarımıza hiperlinklər əlavə edəcəyik, lakin onları haradan əldə edə bilərik? Əvvəlki məqalədə Codecov-u haradan əldə edəcəyimi göstərdim, lakin hansını əldə edəcəyimi qeyd etmədim. Markdown faylımız olduğu üçün bizə Markdown Nişanı da lazımdır:

   Sadəcə onu kopyalayın və Markdown-da sütuna yapışdırın. Ancaq unutmayın ki, Codecov JaCoCo filialında göründü, lakin master-da deyil, ona görə də onu əl ilə düzəltməli olacaqsınız. Travis CI Nişanı layihənin adının birbaşa qarşısında götürülür, burada tikinti jurnalı:

   Nişanı seçirik və sonra parametrlər pəncərəsi açılır:

   Biz mütləq Markdown və sizə lazım olan filialı seçirik. Mən iki filial üçün README.md düzəldəcəm və onlar bir az fərqli olacaq, çünki mən hələ master filialda Codecov tətbiq etməmişəm.




5. Bu layihəni necə idxal etmək və ya klonlamaq barədə məlumat yazaq. Bunu necə edəcəyimi izah etməyəcəyəm, ancaq README.md-də oxuya bilərsiniz. Layihəmizdə istifadə etdiyimiz texnologiyalar haqqında onlara keçidlər yerləşdirərək yazacağıq. Yenə də bu, maarifləndirici layihədir. Yaxşı, əlaqə məlumatlarını yazaq.




6. Markdownumuz hazırdır. Etməli olduğumuz yeganə şey onu layihəmizə əlavə etməkdir və işimiz bitdi. Ancaq hamısı birdən deyil! Gəlin IDEA-mızı açaq və Plugins-də Markdown Dəstəyiniz olduğunu yoxlayırıq:

   Məndə Ultimate IDEA var, ona görə də məndə hər şey var, plagininiz standart olaraq quraşdırılmaya bilər, lakin md uzantılı fayl yaratdığınız zaman onu yükləməyiniz təklif edilməlidir. IDEA-nı yükləyin və yenidən başladın.




7. Yazdığımız Markdown-u idxal etdikdən sonra onu IDEA vasitəsilə açın və lazım gələrsə redaktə edin. IDEA vasitəsilə belə görünür:

   Biz itələyirik. Sonra görürük ki , bir layihə açarkən onun haqqında məlumat dərhal yüklənir, bu bizim README.md-dir:

   İndi, nişanı kliklədikdə, biz birbaşa layihə yığıncağına keçə və orada nəyin olduğunu və necə olduğunu görə bilərik.




8. Codecov Nişanını nümayiş etdirmək üçün JaCoCo filialı üçün də eyni şeyi edəcəm, çünki bizdə hələ README.md yoxdur. Nəticədə, indi iki nişanımız var:

   Codecov kodun əhatə dairəsinin faizini göstərir və o, bizi Codecov səhifəsinə yönləndirə və ətraflı kod əhatəsi hesabatını göstərə bilər.

faydalı bağlantılar

• Wiki bizə Markdown haqqında nə deyir;
• Markdown Editors Directory ;
• Tövsiyə etdiyim Haroopad ;
• JetBrains saytında Markdown haqqında ;
• Eyni JetBrains-də Markdown Navigator ;
• Nişanlar və onlar haqqında hər şey. Burada hər hansı bir nişanın üslubunu seçə və özünüzə uyğunlaşdıra bilərsiniz;
• Açıq mənbə layihənizi necə təkmilləşdirmək olar? Bu məqalə də cavab verəcək ;
• Əvvəlki məqalə

Məqalələrimin silsiləsini ümumiləşdirək

1. Davamlı İnteqrasiya haqqında birinci məqalədə CI-nin nə olduğunu, nə üçün olduğunu və necə istifadə olunacağına baxdıq ;
2. Biz CC ilə oynadıq və onun nə olduğunu və nə üçün lazım olduğunu Kod Əhatəsi haqqında ikinci məqalədə başa düşdük ;
3. Və bu yazıda Markdownun nə olduğunu, nə üçün lazım olduğunu və ondan necə səmərəli istifadə edəcəyini nəzərdən keçirdik.

Bu üç uzun məqaləni oxuduğunuz üçün hamınıza təşəkkür edirəm, ümid edirəm ki, faydalı oldular. Mətndə səhvlər və çatışmazlıqlar ola bilər. Diqqətiniz üçün hamınıza təşəkkür edirik!