Giảm giá

Chúc một ngày tốt lành, đồng nghiệp! Sau một chặng đường dài học hỏi, ai cũng muốn cho nhà tuyển dụng thấy thành quả của mình, và chỉ thể hiện ở khía cạnh tốt nhất, chuyên nghiệp nhất phải không? Tôi nghĩ là có. Vì vậy, ngoài một dự án được thiết kế và triển khai chính xác, chúng ta cần có khả năng chính thức hóa nó. Nhà tuyển dụng sẽ không đọc hết mã dự án của bạn để hiểu nó nói về cái gì và bao gồm những gì trong đó? Trong bài viết này, cuối cùng chúng tôi sẽ tóm tắt hai phần trước, đó là: Tích hợp liên tục và Phạm vi mã , đồng thời cho chúng tôi hiểu trên trang “mặt trước” của dự án nguồn mở những gì chúng tôi đã sử dụng trong dự án của mình và nó đại diện cho điều gì. Hôm nay chúng tôi sẽ nói chuyện với bạn về Markdown, đặt những câu hỏi yêu thích của chúng tôi: “Nó là gì?” và “Tại sao lại như vậy?”, hãy cùng tìm hiểu xem nó được sử dụng ở đâu và cách sử dụng nó. Thậm chí sẽ có một ví dụ, chúng tôi sẽ triển khai nó trong dự án nguồn mở của mình . Vì vậy, chúng ta hãy đi!

"Markdown" là gì?

Vì bạn và tôi đều là lập trình viên nên chúng ta sẽ ngay lập tức lên Google và mở liên kết Wiki đầu tiên , trong đó có nội dung: Markdown là ngôn ngữ đánh dấu nhẹ được tạo ra với mục tiêu viết văn bản dễ đọc và dễ chỉnh sửa nhất nhưng phù hợp với chuyển đổi sang ngôn ngữ cho các ấn phẩm nâng cao (HTML , Rich Text và các ngôn ngữ khác). Ở đây, thành thật mà nói, tôi không có gì nhiều để nói thêm, tôi nghĩ đây là một lời giải thích gần như hoàn hảo.

Tại sao chúng ta cần "Markdown" này?

Thành thật mà nói, nó thực sự không tệ nếu không có nó :D Nhưng hãy nhớ mục tiêu của chúng ta: viết một mẫu dự án có thẩm quyền đã có Tích hợp liên tục và có số liệu thống kê về Phạm vi mã trên tài nguyên Codecov. Tại sao tôi lại đề cập đến điều này? Hơn nữa, Markdown sẽ cho phép chúng tôi lấy dữ liệu từ các tài nguyên này và tự cung cấp dữ liệu hoặc huy hiệu sẽ chuyển hướng chúng tôi đến nơi chúng tôi cần để lấy thông tin này. Thật tiện lợi khi có mọi thứ trên một trang “tiêu đề” thay vì nằm rải rác ở nhiều nơi khác nhau phải không?

Nó được sử dụng ở đâu?

Bất cứ ai đã tải bất kỳ dự án nào của họ lên GitHub ít nhất một lần đều biết rằng GitHub liên tục muốn mời bạn tạo tệp README: Phần mở rộng của tệp này là gì? Đúng vậy, Bolt biết Markdown! Như chúng ta đã biết, tệp này rất dễ dàng được điều chỉnh sang nhiều định dạng và được chuyển đổi thành HTML mà chúng ta cần. Nhưng hãy dành thời gian và đừng vội thêm nó trực tiếp vào GitHub ngay lập tức.

Làm thế nào để làm việc với nó?

Đầu tiên, như bạn có thể nhận thấy, chúng ta có thể thêm nó trực tiếp vào GitHub và nó sẽ hoạt động! Nhưng không phải lúc nào chúng ta cũng cần thêm nó vào chỉ một dự án. Hoặc ví dụ như chúng tôi muốn suy nghĩ nhiều hơn về cách chúng tôi tạo ra nó. Và ở đây GitHub không còn phù hợp với chúng tôi nữa. Và nói chung, chúng ta có thể tạo file Markdown không chỉ với mục đích đẩy chúng lên GitHub. Thứ hai, chúng tôi có thể tạo nó trực tiếp thông qua IDEA, đó chính xác là những gì chúng tôi sẽ làm, nhưng không phải ngay lập tức, vì lý do tại sao chúng tôi cần một môi trường phát triển mạnh mẽ để viết một tệp nhỏ? Ở đây tôi khuyên bạn nên duyệt danh mục các trình chỉnh sửa tệp Markdown dễ dàng và không dễ dàng như vậy. Đối với bản thân tôi, tôi đã chọn Haroopad , nó rất đơn giản, dễ tiếp cận, thể hiện ngay những gì bạn đang viết (IDEA cũng vậy) và có gợi ý cú pháp. Cửa sổ soạn thảo trông như thế này: Ở đây tôi đã mở README.md làm sẵn cho một trong các dự án của mình. Bên trái là bảng cheat, bên phải là màn hình, ở giữa là văn bản. Mọi thứ đều rất nguyên thủy và đơn giản. Bạn cũng có thể thấy các huy hiệu mà chúng tôi sẽ nói đến ngay sau đây. Những người chọn cách khác để ghi những tệp này - đừng lo lắng, tất cả những gì sẽ khác là giao diện đồ họa. Văn bản, cú pháp và hiển thị sẽ không thay đổi. Ví dụ Nhiệm vụ rất đơn giản: viết README.md sao cho nó chứa: thông tin về dự án (bao gồm huy hiệu), thông tin về việc nhập dự án, thông tin về việc thực hiện dự án, thông tin về địa chỉ liên hệ của tác giả. Mọi thứ đều rất đơn giản và nguyên thủy, như tôi đã nói. Hãy bắt tay vào công việc.

1. Hãy viết một tiêu đề - tên dự án của chúng tôi.

   Tiêu đề chính và lớn nhất được tạo bằng toán tử băm " # " và sau đó tiêu đề được viết. Trong trường hợp của chúng ta:

   # ForJavaRushPublication

2. Sau đó, chúng ta sẽ viết tiêu đề nhỏ hơn một chút và chúng ta sẽ viết "Thông tin dự án". Tiêu đề nhỏ hơn được đặt trước nhiều " # " hơn:

   ## Information

   Và sau đó chúng tôi sẽ viết thông tin về dự án.

3. Hãy chèn liên kết đến bài viết của chúng tôi. Việc này được thực hiện rất đơn giản, nếu bạn sử dụng Harooppad thì chỉ cần gõ cheat sheet và mẫu sẽ tự chèn vào. Cú pháp là: " [text](url) ";

4. Hãy chèn huy hiệu. Chúng ta hãy xem xét kỹ hơn ở đây.

   Đầu tiên chúng ta hãy sắp xếp chúng theo dạng bàn cho đẹp. Sẽ có 2 cột và 2 cột. Cú pháp sẽ trông giống như thế này:

   Và kết quả sẽ như thế này:

   Tiếp theo, chúng tôi sẽ chèn siêu liên kết vào huy hiệu của mình, nhưng chúng tôi có thể lấy chúng ở đâu? Tôi đã chỉ ra trong bài viết trước nơi lấy Codecov, nhưng tôi không đề cập đến nơi lấy Codecov. Vì chúng tôi có tệp Markdown nên chúng tôi cũng cần Huy hiệu Markdown:

   Chỉ cần sao chép và dán vào một cột trong Markdown của chúng tôi. Nhưng đừng quên rằng Codecov đã xuất hiện trong nhánh JaCoCo chứ không phải ở nhánh chính, vì vậy bạn sẽ phải sửa nó theo cách thủ công. Huy hiệu Travis CI được lấy ngay đối diện với tên dự án, trong đó nhật ký xây dựng là:

   Chúng tôi chọn huy hiệu và sau đó cửa sổ cài đặt bật lên:

   Chúng tôi chắc chắn chọn Markdown và chi nhánh mà bạn cần. Tôi sẽ tạo README.md cho hai nhánh và chúng sẽ hơi khác nhau một chút vì tôi chưa triển khai Codecov trong nhánh chính.




5. Hãy viết thông tin về cách nhập hoặc sao chép dự án này. Tôi sẽ không giải thích cách thực hiện việc này nhưng bạn có thể đọc nó trong README.md của tôi. Chúng tôi sẽ viết về những công nghệ mà chúng tôi đã sử dụng trong dự án của mình, đặt liên kết đến chúng. Tuy nhiên, đây là một dự án giáo dục. Nào, hãy ghi lại thông tin liên lạc.




6. Markdown của chúng tôi đã sẵn sàng. Tất cả những gì chúng ta phải làm là thêm nó vào dự án của mình và thế là xong. Nhưng không phải tất cả cùng một lúc! Hãy mở IDEA của chúng tôi và trong Plugin, chúng tôi kiểm tra xem bạn có Hỗ trợ Markdown hay không:

   Tôi có Ultimate IDEA nên tôi có mọi thứ, plugin của bạn có thể không được cài đặt theo mặc định, nhưng khi bạn tạo một tệp có phần mở rộng md, bạn sẽ được nhắc tải xuống. Tải xuống và khởi động lại IDEA của bạn.




7. Sau khi nhập Markdown mà chúng tôi đã viết, hãy mở nó thông qua IDEA và chỉnh sửa nó nếu cần. Đây là những gì nó trông giống như thông qua IDEA:

   Chúng tôi đẩy. Sau đó, chúng tôi thấy rằng khi mở một dự án, thông tin về nó sẽ được tải ngay lập tức, đây là README.md của chúng tôi:

   Bây giờ, khi nhấp vào huy hiệu, chúng ta có thể chuyển thẳng đến phần lắp ráp dự án và xem chúng ta có những gì ở đó và như thế nào.




8. Tôi sẽ làm điều tương tự với chi nhánh JaCoCo để chứng minh Huy hiệu Codecov vì chúng tôi chưa có README.md trong đó. Kết quả là hiện tại chúng tôi có hai huy hiệu:

   Codecov hiển thị tỷ lệ phần trăm phạm vi bảo hiểm của mã và nó cũng có thể chuyển hướng chúng ta đến trang Codecov và hiển thị báo cáo phạm vi bảo hiểm mã chi tiết.

Liên kết hữu ích

• Wiki cho chúng ta biết gì về Markdown;
• Thư mục biên tập Markdown ;
• Harooppad mà tôi khuyên dùng;
• Giới thiệu về Markdown trên trang web JetBrains ;
• Markdown Navigator trên cùng JetBrains;
• Huy hiệu và mọi thứ về chúng. Tại đây bạn có thể chọn kiểu của bất kỳ huy hiệu nào và tùy chỉnh nó cho riêng mình;
• Làm cách nào để nâng cấp dự án nguồn mở của bạn? Bài viết này cũng sẽ trả lời ;
• bài báo trước

Hãy tóm tắt lại loạt bài viết của tôi

1. Chúng ta đã xem CI là gì, nó dùng để làm gì và cách sử dụng nó trong bài viết đầu tiên về Tích hợp liên tục ;
2. Chúng tôi đã tìm hiểu về CC và hiểu nó là gì cũng như tại sao nó lại cần thiết trong bài viết thứ hai về Bảo hiểm Mã ;
3. Và trong bài viết này chúng ta đã xem Markdown là gì, tại sao cần thiết và cách sử dụng nó một cách hiệu quả.

Cảm ơn tất cả các bạn đã đọc ba bài viết dài này, tôi hy vọng chúng hữu ích. Có thể có sai sót và thiếu sót trong văn bản. Cảm ơn tất cả các bạn đã quan tâm!