Markdown là một cú pháp gọn nhẹ và dễ sử dụng để tạo kiểu cho tất cả các hình thức viết trên nền tảng GitHub.
Bạn sẽ học được gì:
- Cách định dạng Markdown giúp chỉnh sửa cộng tác theo kiểu dễ dàng
- Markdown khác với cách tiếp cận định dạng truyền thống như thế nào
- Cách sử dụng Markdown để định dạng văn bản
- Cách tận dụng kết xuất Markdown tự động của GitHub
- Cách áp dụng các tiện ích mở rộng Markdown độc đáo của GitHub
Markdown là gì?
Markdown là một cách để tạo kiểu văn bản trên web. Bạn điều khiển việc hiển thị tài liệu; định dạng các từ in đậm hoặc in nghiêng, thêm hình ảnh và tạo danh sách chỉ là một vài trong số những điều chúng ta có thể làm với Markdown. Hầu hết, Markdown chỉ là văn bản thông thường với một vài ký tự không phải là chữ cái được ném vào, như # hoặc *.
Bạn có thể sử dụng Markdown hầu hết các địa điểm xung quanh GitHub:
Ý chính
Nhận xét về các vấn đề và yêu cầu kéo
Các tệp có phần mở rộng .mdhoặc.markdown
Để biết thêm thông tin, hãy xem Viết Viết trên GitHub 'trong Trợ giúp GitHub .
Hướng dẫn cú pháp
Dưới đây là tổng quan về cú pháp Markdown mà bạn có thể sử dụng ở bất cứ đâu trên GitHub.com hoặc trong các tệp văn bản của riêng bạn.
Tiêu đề
Nhấn mạnh
This text will be italic
This will also be italic
This text will be bold
This will also be bold
You can combine them
Danh sách
Không có thứ tự
- Item 1
- Item 2
- Item 2a
- Item 2b
Đặt hàng
- Item 1
- Item 2
- Item 3
- Item 3a
- Item 3b
Liên kết
http://github.com - automatic!
GitHub
Blockquote
As Kanye West said:
We're living the future so
the present is our past.
Mã nội tuyến
I think you should use an
<addr>element here instead.
GitHub Hương vị Markdown
GitHub.com sử dụng phiên bản cú pháp Markdown của riêng mình, cung cấp một bộ tính năng hữu ích bổ sung, nhiều tính năng giúp làm việc với nội dung trên GitHub.com dễ dàng hơn.
Lưu ý rằng một số tính năng của GitHub Flavored Markdown chỉ có sẵn trong phần mô tả và nhận xét về Sự cố và Yêu cầu Kéo. Chúng bao gồm @mentions cũng như các tham chiếu đến băm SHA-1, Các vấn đề và Yêu cầu kéo. Danh sách tác vụ cũng có sẵn trong các bình luận Gist và trong các tệp Gist Markdown.
Danh sách nhiệm vụ
- [x] @mentions, #refs, links, formatting, and
tagssupported - [x] list syntax required (any unordered or ordered list supported)
- [x] this is a complete item
- [ ] this is an incomplete item
Nếu bạn bao gồm một danh sách nhiệm vụ trong bình luận đầu tiên của một vấn đề, bạn sẽ nhận được một chỉ báo tiến trình tiện dụng trong danh sách vấn đề của bạn. Nó cũng hoạt động trong Pull Requests!
Những cái bàn
Bạn có thể tạo các bảng bằng cách tập hợp một danh sách các từ và chia chúng với các dấu gạch nối -(cho hàng đầu tiên), sau đó tách từng cột bằng một ống |:
| First Header | Second Header |
|---|---|
| Content from cell 1 | Content from cell 2 |
| Content in the first column | Content in the second column |
Sẽ trở thành:
Tiêu đề đầu tiên Tiêu đề thứ hai
Nội dung từ ô 1 Nội dung từ ô 2
Nội dung trong cột đầu tiên Nội dung trong cột thứ hai
Tài liệu tham khảo SHA
Mọi tham chiếu đến hàm băm SHA-1 của một cam kết sẽ được tự động chuyển đổi thành một liên kết đến cam kết đó trên GitHub.
#1
mojombo#1
mojombo/github-flavored-markdown#1
Tên người dùng @mentions
Nhập một @biểu tượng, theo sau là tên người dùng, sẽ thông báo cho người đó đến và xem nhận xét. Đây được gọi là một @ @ionion, vì bạn đang đề cập đến cá nhân. Bạn cũng có thể @mention nhóm trong một tổ chức.
Liên kết tự động cho các URL
Bất kỳ URL nào (như http://www.github.com/) sẽ được tự động chuyển đổi thành một liên kết có thể nhấp.
Thông qua
Bất kỳ từ nào được bọc bằng hai dấu ngã (như this) sẽ xuất hiện gạch bỏ.
Biểu tượng cảm xúc
GitHub hỗ trợ biểu tượng cảm xúc !
Để xem danh sách mọi hình ảnh chúng tôi hỗ trợ, hãy xem [Bảng biểu tượng cảm xúc .] (https://github.com/ikatyang/emoji-cheat-sheet/blob/master/README.md)
Còn nhiều nội dung mình còn chưa rõ, các bạn cùng mình bổ sung dưới comment để mọi người cùng biết. Điều này sẽ giúp nhiều người Việt Nam có cơ hội tham gia mạng xã hội nay ho này! Love all!