không thể tìm thấy tài liệu chi tiết, cụ thể để sử dụng đánh dấu trên dự án github và trang của người dùng

Question

Tôi đang trong quá trình thêm các trang github vào một số bản repo của tôi và trang người dùng của tôi. Đối với nhiều trang web, tôi muốn sử dụng định dạng Markdown.

Tuy nhiên, vì tôi chỉ có thể tìm thấy thông tin vague, undetailed về cách thực hiện việc này, tôi đang thực hiện thử và lỗi để tìm hiểu cách hoạt động.

Tài liệu thực sự ở đâu? Các chi tiết đẫm máu?

---

Here là thông tin tốt nhất mà tôi đã tìm thấy cho đến nay, trong đó nói rằng:

• sử dụng tên chi nhánh đặc biệt gh-pages để tạo ra một trang web cho một repo dự án

• một dòng ba câu thần chú ở đầu tệp là cần thiết:

  --- 
  title: something 
  --- 
  

• hậu tố được thay đổi thành .html

Nhưng tôi là trái với nhiều câu hỏi về chi tiết, chẳng hạn như:

• tôi có thể nhập các file css?
• blurb "tiêu đề" đó thực sự làm gì?
• cần phải có những hậu tố nào?

vv Vì vậy, tôi thực sự muốn xem tài liệu chi tiết cho tất cả các tính năng.

---

Hãy lưu ý rằng câu hỏi này không phải là cách sử dụng cú pháp Markdown, mà cách khai thác ma thuật của github để tự động tạo html từ Markdown trong phạm vi trang người dùng và dự án.

Answer 1

làm thế nào để khai thác sức kỳ diệu github cho tự động tạo ra html từ Markdown trong phạm vi người dùng và dự án trang

Có vẻ như bạn đang nói về Jekyll.

---

"Tiêu đề" đó thực sự làm gì?

title là một phần của YAML Front Matter. Nó cơ bản là một biến mà bạn có thể access qua page.title

---

hậu tố gì các tập tin cần phải có?

Miễn là tệp có phần YAML Front Matter, nó sẽ được Jekyll chuyển đổi.Điều tương tự cũng sẽ xảy ra đối với bất kỳ tệp nào .html, .markdown, .md hoặc .textile trong thư mục gốc hoặc thư mục gốc của trang web của bạn không được liệt kê ở trên.

github.com/mojombo/jekyll/wiki/usage

Answer 2

Chỉ những tập tin với phần mở rộng .md hoặc .markdown sẽ được dịch sang HTML trên GitHub tài trang.

Tệp có tiện ích mở rộng .html và .textile là không được dịch, theo cố gắng của tôi.

Lưu ý rằng mã hóa UTF8 nên tránh.