Markdown

Рӯзи хуб, ҳамкорон! Пас аз як сафари тӯлонии омӯзиш, ҳама мехоҳад ба корфармо самараи худро нишон диҳад ва танҳо аз ҷониби беҳтарин ва касбӣ нишон диҳад, дуруст? Ман фикр мекунам ҳа. Аз ин ру, ба гайр аз лоихаи дуруст тартиб додашуда ва ба амал баровардашуда, мо бояд онро ба расмият дароварда тавонем. Корфармо тамоми codeи лоиҳаи шуморо намехонад, то бифаҳмад, ки он дар бораи чӣ аст ва дар он чӣ дохил карда шудааст? Дар ин мақола, мо ниҳоят ду чизи қаблиро ҷамъбаст хоҳем кард, яъне: Интегратсияи муттасил ва фарогирии code ва биёед дар варақи "пеш аз" лоиҳаи кушодаасос бифаҳмем, ки мо дар лоиҳаи худ чӣ истифода кардем ва он чиро ифода мекунад. Имрӯз мо бо шумо дар бораи Markdown сӯҳбат хоҳем кард ва саволҳои дӯстдоштаи худро пурсед: "Ин чист?" ва "Чаро ин аст?", биёед бифаҳмем, ки он дар куҷо истифода мешавад ва бо он чӣ гуна кор кардан мумкин аст. Ҳатто як мисоле хоҳад буд, мо онро дар лоиҳаи кушодаи худ амалӣ хоҳем кард . Пас, биёед!

"Markdown" чист?

Азбаски ману шумо барномасоз ҳастем, мо фавран ба Google меравем ва аввалин истиноди Wiki-ро мекушоем , ки дар он гуфта мешавад: Markdown забони сабуки аломатгузорӣ аст, ки бо ҳадафи навиштани матни аз ҳама хондашаванда ва таҳриршаванда сохта шудааст, аммо барои табдил ба забонҳо барои нашрияҳои пешрафта (HTML, Rich Text ва ғайра). Дар ин ҷо, ростқавлона, ман чизе барои илова кардан надорам, ман фикр мекунам, ки ин шарҳи қариб комил аст.

Чаро ба мо ин "Markdown" лозим аст?

Рости гап, бе ин ҳам бад нест :D Аммо биёед ҳадафи худро дар хотир дорем: навиштани як қолаби лоиҳаи салоҳиятдор, ки аллакай Интегратсияи муттасил дорад ва дар манбаи Codecov омори фарогирии code дорад. Чаро ман инро зикр кардам? Ғайр аз он, Markdown ба мо имкон медиҳад, ки аз ин захираҳо маълумот гирем ва худи маълумот ё нишонҳоеро пешниҳод кунем, ки моро ба он ҷое, ки барои гирифтани ин маълумот лозим аст, равона кунанд. Ҳама чизро дар як саҳифаи "унвон" доштан қулай аст, на дар ҷойҳои гуногун, ҳамин тавр не?

Дар куҷо истифода мешавад?

Ҳар касе, ки ягон лоиҳаи худро ҳадди аққал як бор ба GitHub бор кардааст, медонад, ки GitHub исроркорона мехоҳад шуморо ба эҷоди файли README даъват кунад: Васеъшавии ин файл чист? Ин дуруст аст, Болт Маркдаунро медонад ! Тавре ки мо аллакай медонем, ин файл хеле ба осонӣ ба бисёр форматҳо танзим карда мешавад ва ба HTML ба мо лозим аст. Аммо биёед вақти худро сарф кунем ва шитоб накунед, ки онро бевосита ба GitHub илова кунед.

Бо он чӣ гуна бояд кор кард?

Аввалан, тавре ки шумо пайхас кардаед, мо метавонем онро мустақиман ба GitHub илова кунем ва он кор хоҳад кард! Аммо мо набояд ҳамеша онро ба як лоиҳа илова кунем, масалан. Ё масалан, мо мехоҳем бештар дар бораи он фикр кунем, ки чӣ гуна онро эҷод мекунем. Ва дар ин ҷо GitHub дигар барои мо мувофиқ нест. Ва умуман, мо метавонем файлҳои Markdown-ро на танҳо бо мақсади тела додан ба GitHub эҷод кунем. Дуюм, мо метавонем онро мустақиман тавассути IDEA эҷод кунем, ки маҳз ҳамон чизест, ки мо мекунем, аммо на дарҳол, аз он сабаб, ки чаро барои навиштани як файли хурд ба мо муҳити тавонои рушд лозим аст? Дар ин ҷо ман тавсия медиҳам, ки каталоги муҳаррирони файли Markdown осон ва на он қадар осонро аз назар гузаронам. Барои худам, ман Haroopad -ро интихоб кардам , он хеле содда, дастрас аст, тасвири фаврии он чизеро, ки шумо менависед (IDEA низ мекунад) ва дорои ишораи синтаксис мебошад. Равзанаи муҳаррир чунин аст: Дар ин ҷо ман як README.md-и тайёри яке аз лоиҳаҳои худро кушодам. Дар тарафи чап варақи фиреб, дар тарафи рост дисплей, дар марказ матн аст. Ҳама чиз хеле ибтидоӣ ва оддӣ аст. Шумо инчунин метавонед нишонаҳоеро бинед, ки мо дар бораи онҳо ба наздикӣ сӯҳбат хоҳем кард. Онҳое, ки роҳи дигари навиштани ин файлҳоро интихоб мекунанд - хавотир нашавед, танҳо интерфейси графикӣ фарқ мекунад. Матн, синтаксис ва намоиш бетағйир мемонанд. Мисол Вазифа хеле содда аст: README.md-ро нависед, то дар он бошад: маълумот дар бораи лоиҳа (аз ҷумла нишонаҳо), маълумот дар бораи воридоти лоиҳа, маълумот дар бораи татбиқи лоиҳа, маълумот дар бораи алоқаҳои муаллиф. Ҳама чиз хеле содда ва ибтидоӣ аст, чунон ки ман аллакай гуфтам. Биёед, ба тиҷорат равем.

1. Биёед сарлавҳа нависем - номи лоиҳаи мо.

   Сарлавҳаи асосӣ ва калонтарин бо истифода аз оператори hash " # " сохта мешавад ва баъд сарлавҳа навишта мешавад. Дар ҳолати мо:

   # ForJavaRushPublication

2. Он гоҳ мо сарлавҳаи каме хурдтар менависем ва мо "Маълумоти лоиҳа" -ро менависем. Пеш аз сарлавҳаи хурдтар ҳарфҳои " # " зиёданд :

   ## Information

   Ва он гоҳ мо дар бораи лоиҳа маълумот менависем.

3. Биёед истинодҳоро ба мақолаҳои худ ворид кунем. Ин хеле содда анҷом дода мешавад ва агар шумо Haroopad -ро истифода баред, танҳо варақи фиребро интихоб кунед ва қолаб худаш ворид карда мешавад. Синтаксис ин аст: " [text](url) ";

4. Биёед нишонаҳо гузорем. Биёед дар ин ҷо бодиққат назар кунем.

   Аввалан, биёед онҳоро дар шакли миз, барои зебоӣ тартиб диҳем. 2 сутун ва 2 сутун хохад буд. Синтаксис чунин хоҳад буд:

   Ва натиҷа чунин хоҳад буд:

   Баъдан, мо ба нишонҳои худ гиперҳаволаҳо дохил мекунем, аммо мо онҳоро аз куҷо гирифта метавонем? Ман дар мақолаи қаблӣ нишон додам, ки Codecov-ро аз куҷо гирифтан мумкин аст, аммо нагуфтам, ки кадомашро гирифтан мумкин аст. Азбаски мо файли Markdown дорем, ба мо инчунин нишонаи Markdown лозим аст:

   Танҳо онро нусхабардорӣ кунед ва ба сутуни Markdown-и мо часбонед. Аммо фаромӯш накунед, ки Codecov дар фorали JaCoCo пайдо шуд, аммо на дар усто, бинобар ин шумо бояд онро дастӣ ислоҳ кунед. Travis CI Badge бевосита дар муқобor номи лоиҳа гирифта мешавад, ки дар он сабти сохтмон ин аст:

   Мо нишонаро интихоб мекунем ва он гоҳ равзанаи танзимот пайдо мешавад:

   Мо бешубҳа Markdown ва фorалеро, ки ба шумо лозим аст, интихоб мекунем. Ман README.md-ро барои ду шоха месозам ва онҳо каме фарқ хоҳанд кард, зеро ман то ҳол Codecov-ро дар фorали асосӣ татбиқ накардаам.




5. Биёед маълумотро дар бораи чӣ гуна ворид кардан ё клон кардани ин лоиҳа нависед. Ман инро шарҳ намедиҳам, аммо шумо метавонед онро дар README.md хонед. Мо дар бораи технологияҳое, ки дар лоиҳаи худ истифода мебарем, менависем ва истинод ба онҳо. Бо вуҷуди ин, ин лоиҳаи таълимӣ аст. Хуб, биёед маълумоти тамосро нависед.




6. Markdown мо омода аст. Мо танҳо бояд онро ба лоиҳаи худ илова кунем ва мо анҷом медиҳем. Аммо на ҳама якбора! Биёед IDEA-и худро кушоем ва дар плагинҳо мо тафтиш мекунем, ки шумо дастгирии Markdown доред:

   Ман Ultimate IDEA дорам, бинобар ин ман ҳама чизро дорам, плагини шумо бо нобаёнӣ насб карда нашавад, аммо вақте ки шумо файлеро бо тамдиди md эҷод мекунед, аз шумо бояд дархост карда шавад, ки онро зеркашӣ кунед. IDEA-и худро зеркашӣ ва аз нав оғоз кунед.




7. Пас аз ворид кардани Markdown, ки мо навиштем, онро тавассути IDEA кушоед ва агар лозим бошад, таҳрир кунед. Ин аст он чизе ки тавассути IDEA ба назар мерасад:

   Мо тела медиҳем. Пас мо мебинем, ки ҳангоми кушодани лоиҳа маълумот дар бораи он фавран бор карда мешавад, ин README.md мост:

   Ҳоло, вақте ки мо нишонаро пахш мекунем, мо метавонем мустақиман ба маҷлиси лоиҳа ҷаҳида, бубинем, ки мо дар он ҷо чӣ дорем ва чӣ гуна.




8. Ман барои фorали JaCoCo ҳамин корро мекунам, то нишони Codecov -ро нишон диҳам, зеро мо ҳоло дар он README.md надорем. Дар натиҷа, мо ҳоло ду нишони сарисинагӣ дорем:

   Codecov фоизи фарогирии codeро нишон медиҳад ва он инчунин метавонад моро ба саҳифаи Codecov равона кунад ва гузориши муфассали фарогирии codeро нишон диҳад.

истинодҳои муфид

• Он чизе ки Wiki ба мо дар бораи Markdown мегӯяд ;
• Directory Editors Markdown ;
• Haroopad , ки ман тавсия медиҳам;
• Дар бораи Markdown дар вебсайти JetBrains ;
• Navigator Markdown дар ҳамон JetBrains;
• Нишонҳо ва ҳама чиз дар бораи онҳо. Дар ин ҷо шумо метавонед услуби дилхоҳ нишони сарисинагӣ интихоб кунед ва онро барои худ танзим кунед;
• Лоиҳаи кушодаи худро чӣ гуна навсозӣ кардан мумкин аст? Ин мақола инчунин ҷавоб хоҳад дод ;
• Мақолаи қаблӣ

Биёед силсилаи мақолаҳои маро ҷамъбаст кунем

1. Мо ба он назар кардем, ки CI чист, он барои чӣ аст ва чӣ гуна онро дар мақолаи аввал дар бораи Интегратсияи муттасил истифода бурдан мумкин аст ;
2. Мо бо CC бозӣ кардем ва фаҳмидем, ки ин чист ва чаро он дар мақолаи дуюм дар бораи фарогирии Кодекс лозим аст ;
3. Ва дар ин мақола мо дида баромадем, ки Markdown чист, чаро он лозим аст ва чӣ гуна онро самаранок истифода бурдан мумкин аст.

Ташаккур ба ҳама барои хондани ин се мақолаи дароз, ман умедворам, ки онҳо муфид буданд. Мумкин аст, ки дар матн хатоҳо ва камбудиҳо ҷой дошта бошанд. Ташаккур ба ҳама барои таваҷҷӯҳатон!