Penurunan harga

Selamat hari, rakan sekerja! Selepas perjalanan yang panjang untuk belajar, semua orang mahu menunjukkan kepada majikan hasil mereka, dan menunjukkan kepada mereka hanya dari sisi yang terbaik, profesional, bukan? Saya rasa betul. Oleh itu, sebagai tambahan kepada projek yang direka dan dilaksanakan dengan betul, kita perlu dapat memformalkannya. Majikan tidak akan membaca semua kod projek anda untuk memahami tentang perkara itu dan apa yang disertakan di dalamnya? Dalam artikel ini, kami akhirnya akan meringkaskan dua sebelumnya, iaitu: Penyepaduan Berterusan dan Liputan Kod , dan biarkan kami memahami pada helaian "depan" projek sumber terbuka apa yang kami gunakan dalam projek kami dan apa yang diwakilinya. Hari ini kami akan bercakap dengan anda tentang Markdown, tanya soalan kegemaran kami: "Apakah itu?" dan "Mengapa ini?", mari kita cari tahu di mana ia digunakan dan cara menggunakannya. Malah akan ada contoh, kami akan melaksanakannya dalam projek sumber terbuka kami . Jadi, mari pergi!

Apakah "Markdown"?

Memandangkan anda dan saya adalah pengaturcara, kami akan segera pergi ke Google dan membuka pautan Wiki pertama , yang mengatakan: Markdown ialah bahasa penanda ringan yang dicipta dengan matlamat untuk menulis teks yang paling mudah dibaca dan mudah diedit, tetapi sesuai untuk penukaran kepada bahasa untuk penerbitan lanjutan (HTML , Rich Text dan lain-lain). Di sini, sejujurnya, saya tidak mempunyai banyak perkara untuk ditambah, saya fikir ini adalah penjelasan yang hampir sempurna.

Mengapa kita memerlukan "Markdown" ini?

Sejujurnya, ia sebenarnya tidak buruk tanpanya :D Tetapi mari kita ingat matlamat kita: untuk menulis templat projek yang cekap yang sudah mempunyai Integrasi Berterusan dan mempunyai statistik Liputan Kod pada sumber Codecov. Mengapa saya menyebut perkara ini? Selain itu, Markdown akan membolehkan kami mengambil data daripada sumber ini dan menyediakan data itu sendiri, atau lencana yang akan mengubah hala kami ke tempat yang kami perlukan untuk mendapatkan maklumat ini. Adalah mudah untuk mempunyai segala-galanya pada satu halaman "tajuk", dan bukannya berselerak di tempat yang berbeza, bukan?

Di mana ia digunakan?

Sesiapa sahaja yang telah memuat naik mana-mana projek mereka ke GitHub sekurang-kurangnya sekali tahu bahawa GitHub sentiasa mahu menjemput anda untuk mencipta fail README: Apakah sambungan fail ini? Betul, Bolt tahu Markdown! Seperti yang kita sedia maklum, fail ini sangat mudah dilaraskan kepada banyak format dan ditukar kepada HTML yang kita perlukan. Tetapi mari luangkan masa kita dan jangan tergesa-gesa untuk segera menambahkannya terus ke GitHub.

Bagaimana untuk bekerja dengannya?

Pertama, seperti yang anda mungkin perasan, kami boleh menambahkannya terus ke GitHub dan ia akan berfungsi! Tetapi kita tidak semestinya perlu menambahkannya pada satu projek sahaja, sebagai contoh. Atau sebagai contoh kita ingin memikirkan lebih lanjut tentang cara kita menciptanya. Dan di sini GitHub tidak lagi sesuai untuk kami. Dan secara umum, kita boleh membuat fail Markdown bukan sahaja untuk tujuan menolaknya ke GitHub. Kedua, kita boleh menciptanya secara langsung melalui IDEA, iaitu apa yang akan kita lakukan, tetapi tidak serta-merta, atas sebab mengapa kita memerlukan persekitaran pembangunan yang berkuasa untuk menulis satu fail kecil? Di sini saya mengesyorkan menyemak imbas katalog editor fail Markdown yang mudah dan tidak begitu mudah. Untuk diri saya sendiri, saya memilih Haroopad , ia sangat mudah, boleh diakses, mempunyai perwakilan segera tentang perkara yang anda tulis (IDEA juga), dan mempunyai petunjuk sintaks. Beginilah rupa tetingkap editor: Di sini saya membuka README.md siap sedia untuk salah satu projek saya. Di sebelah kiri adalah helaian tipu, di sebelah kanan adalah paparan, di tengah adalah teks. Semuanya sangat primitif dan mudah. Anda juga boleh melihat lencana, yang akan kita bincangkan sebentar lagi. Mereka yang memilih cara yang berbeza untuk menulis fail ini - jangan risau, semua yang berbeza adalah antara muka grafik. Teks, sintaks dan paparan akan kekal tidak berubah. Contoh Tugasnya sangat mudah: tulis README.md supaya ia mengandungi: maklumat tentang projek (termasuk lencana), maklumat tentang mengimport projek, maklumat tentang pelaksanaan projek, maklumat tentang kenalan pengarang. Segala-galanya sangat mudah dan primitif, seperti yang telah saya katakan. Mari berniaga.

1. Mari kita tulis tajuk - nama projek kami.

   Tajuk utama dan terbesar dibuat menggunakan pengendali cincang " # " dan kemudian tajuk ditulis. Dalam kes kami:

   # ForJavaRushPublication

2. Kemudian kami akan menulis tajuk yang lebih kecil dan kami akan menulis "Maklumat Projek". Pengepala yang lebih kecil didahului dengan lebih banyak " # ":

   ## Information

   Dan kemudian kami akan menulis maklumat mengenai projek itu.

3. Mari masukkan pautan ke artikel kami. Ini dilakukan dengan sangat mudah, dan jika anda menggunakan Haroopad, taip sahaja helaian cheat dan templat akan dimasukkan sendiri. Sintaksnya ialah: " [text](url) ";

4. Mari masukkan lencana. Mari kita lihat lebih dekat di sini.

   Mula-mula, mari kita susun dalam bentuk meja, untuk kecantikan. Akan ada 2 lajur dan 2 lajur. Sintaks akan kelihatan seperti ini:

   Dan hasilnya akan menjadi seperti ini:

   Seterusnya, kami akan memasukkan hiperpautan pada lencana kami, tetapi di manakah kami boleh mendapatkannya? Saya telah menunjukkan dalam artikel sebelumnya di mana untuk mendapatkan Codecov, tetapi saya tidak menyebut yang mana satu untuk mendapatkan. Memandangkan kami mempunyai fail Markdown, kami juga memerlukan Lencana Markdown:

   Hanya salin dan tampalkannya ke dalam lajur dalam Markdown kami. Tetapi jangan lupa bahawa Codecov muncul di cawangan JaCoCo, tetapi tidak dalam master, jadi anda perlu membetulkannya secara manual. Lencana Travis CI diambil tepat bertentangan dengan nama projek, di mana log binaan ialah:

   Kami memilih lencana, dan kemudian tetingkap tetapan muncul:

   Kami pasti memilih Markdown, dan cawangan yang anda perlukan. Saya akan membuat README.md untuk dua cawangan, dan mereka akan berbeza sedikit, kerana saya belum lagi melaksanakan Codecov dalam cawangan induk.




5. Mari tulis maklumat tentang cara mengimport atau mengklon projek ini. Saya tidak akan menerangkan cara melakukan ini, tetapi anda boleh membacanya dalam README.md saya. Kami akan menulis tentang teknologi yang kami gunakan dalam projek kami, meletakkan pautan kepada mereka. Namun, ini adalah projek pendidikan. Baiklah, mari tulis maklumat hubungan.




6. Markdown kami sudah sedia. Apa yang perlu kami lakukan ialah menambahnya pada projek kami dan kami selesai. Tetapi tidak sekaligus! Mari buka IDEA kami, dan dalam Pemalam kami menyemak sama ada anda mempunyai Sokongan Markdown:

   Saya mempunyai Ultimate IDEA, jadi saya mempunyai segala-galanya, pemalam anda mungkin tidak dipasang secara lalai, tetapi apabila anda mencipta fail dengan sambungan md, anda harus digesa untuk memuat turunnya. Muat turun dan mulakan semula IDEA anda.




7. Selepas mengimport Markdown yang kami tulis, buka melalui IDEA dan editnya jika perlu. Inilah rupanya melalui IDEA:

   Kami menolak. Kemudian kami melihat bahawa apabila membuka projek, maklumat mengenainya segera dimuatkan, ini adalah README.md kami:

   Sekarang, apabila kita mengklik pada lencana, kita boleh melompat terus ke pemasangan projek dan melihat apa yang kita ada di sana dan bagaimana.




8. Saya akan melakukan perkara yang sama untuk cawangan JaCoCo untuk menunjukkan Lencana Codecov, kerana kami belum mempunyai README.md di dalamnya. Hasilnya, kami kini mempunyai dua lencana:

   Codecov menunjukkan peratusan liputan kod, dan ia juga boleh mengubah hala kami ke halaman Codecov dan menunjukkan laporan liputan kod terperinci.

pautan yang berguna

• Apa yang Wiki beritahu kami tentang Markdown;
• Direktori Editor Markdown ;
• Haroopad yang saya cadangkan;
• Mengenai Markdown di laman web JetBrains ;
• Markdown Navigator pada JetBrains yang sama;
• Lencana dan segala-galanya tentangnya. Di sini anda boleh memilih gaya mana-mana lencana dan menyesuaikannya untuk diri sendiri;
• Bagaimana untuk menaik taraf projek sumber terbuka anda? Artikel ini juga akan menjawab ;
• Artikel sebelumnya

Mari kita ringkaskan siri artikel saya

1. Kami melihat apa itu CI, untuk apa ia dan cara menggunakannya dalam artikel pertama tentang Integrasi Berterusan ;
2. Kami bermain-main dengan CC dan memahami apa itu dan mengapa ia diperlukan dalam artikel kedua tentang Liputan Kod ;
3. Dan dalam artikel ini kita melihat apa itu Markdown, mengapa ia diperlukan dan cara menggunakannya dengan berkesan.

Terima kasih semua kerana membaca tiga artikel yang panjang ini, semoga bermanfaat. Mungkin terdapat ralat dan ketinggalan dalam teks. Terima kasih semua atas perhatian anda!