Nhận xét trong Markdown

Question

Cú pháp lưu trữ nhận xét trong tệp đánh dấu là gì, ví dụ: một CVS $ Id $ bình luận ở trên cùng của tập tin? Tôi không tìm thấy gì trên số markdown project.

Answer 1

Tôi tin rằng tất cả các giải pháp được đề xuất trước đây (ngoài những giải pháp yêu cầu triển khai cụ thể) dẫn đến các nhận xét được đưa vào HTML đầu ra, ngay cả khi chúng không được hiển thị.

Nếu bạn muốn nhận xét cho chính mình (người đọc tài liệu đã chuyển đổi không thể xem được, ngay cả với "nguồn xem") bạn có thể (ab) sử dụng nhãn liên kết (để sử dụng với kiểu tham chiếu) liên kết) mà có sẵn trong đặc tả cốt lõi Markdown:

http://daringfireball.net/projects/markdown/syntax#link

đó là:

[comment]: <> (This is a comment, it will not be included) 
[comment]: <> (in the output file unless you use it in) 
[comment]: <> (a reference style link.) 

Hoặc bạn có thể đi xa hơn:

[//]: <> (This is also a comment.) 

Để cải thiện khả năng tương thích nền tảng (và để tiết kiệm một phím tắt) nó cũng có thể sử dụng # (mà là một mục tiêu liên kết hợp pháp) thay vì <>:

[//]: # (This may be the most platform independent comment) 

Nó cũng có thể thận trọng để chèn một dòng trống trước và sau loại nhận xét này, vì một số trình phân tích cú pháp Markdown có thể không thích các định nghĩa liên kết đánh với văn bản thông thường.

Điều này sẽ hoạt động với hầu hết các trình phân tích cú pháp Markdown, vì nó là một phần của đặc tả cốt lõi. (ngay cả khi hành vi khi nhiều liên kết được xác định hoặc khi liên kết được xác định nhưng không bao giờ được sử dụng, không được chỉ định nghiêm ngặt).

Answer 2

tôi sử dụng các thẻ HTML tiêu chuẩn, như

<!--- 
your comment goes here 
and here 
--> 

Lưu ý các dấu gạch ngang ba. Ưu điểm là nó hoạt động với pandoc khi tạo ra đầu ra TeX hoặc HTML. Thông tin thêm có sẵn trên nhóm pandoc-discuss.

Answer 3

Cách khác là đặt nhận xét trong các thẻ HTML cách điệu. Bằng cách này, bạn có thể chuyển đổi chế độ hiển thị của mình nếu cần. Ví dụ, xác định một lớp bình luận trong CSS stylesheet của bạn.

.comment { display: none; }

Sau đó, sau đây tăng cường Markdown

We do <span class="comment">NOT</span> support comments

xuất hiện như sau trong trình duyệt

We do support comments

Answer 4

Tiết lộ: Tôi đã viết các plugin.

Vì câu hỏi không chỉ định triển khai đánh dấu cụ thể, tôi muốn đề cập đến Comments Plugin cho python-markdown, thực hiện cùng một kiểu bình luận tổng quát được đề cập ở trên.

Answer 5

Đồng thời xem Đánh dấu phê bình, được hỗ trợ bởi số lượng công cụ Markdown ngày càng tăng.

http://criticmarkup.com/

Comment {>> <<} 

Lorem ipsum dolor sit amet.{>>This is a comment<<} 

Highlight+Comment {== ==}{>> <<} 

Lorem ipsum dolor sit amet, consectetur adipiscing elit. {==Vestibulum at orci magna. Phasellus augue justo, sodales eu pulvinar ac, vulputate eget nulla.==}{>>confusing<<} Mauris massa sem, tempor sed cursus et, semper tincidunt lacus. 

Answer 6

Nếu bạn đang sử dụng Jekyll hoặc octopress sau đây cũng sẽ làm việc.

{% comment %} 
    These commments will not include inside the source. 
{% endcomment %} 

Thẻ chất lỏng {% comment %} được phân tích cú pháp đầu tiên và loại bỏ trước khi bộ xử lý MarkDown thậm chí được xử lý. Khách truy cập sẽ không nhìn thấy khi họ cố gắng xem nguồn từ trình duyệt của họ.

Answer 7

này hoạt động trên GitHub:

[](Comment text goes here) 

HTML kết quả trông giống như:

<a href="Comment%20text%20goes%20here"></a> 

cơ bản Đó là một liên kết rỗng. Rõ ràng bạn có thể đọc điều đó trong nguồn của văn bản được hiển thị, nhưng bạn vẫn có thể làm điều đó trên GitHub.

Answer 8

nghiên cứu nhỏ này chứng minh và cải tiến the answer by Magnus

Cú pháp nền tảng độc lập nhất là

(empty line) 
[comment]: # (This actually is the most platform independent comment) 

Cả hai điều kiện rất quan trọng:

1. Sử dụng # (và không <>)
2. Với dòng trống trước nhận xét. Dòng trống sau khi nhận xét không ảnh hưởng đến kết quả.

Các Markdown đặc điểm kỹ thuật nghiêm ngặt CommonMark chỉ hoạt động như dự định với cú pháp này (và không phải với <> và/hoặc một dòng trống)

Để chứng minh điều này chúng ta sẽ sử dụng Babelmark2, được viết bởi John MacFarlane. Công cụ này kiểm tra kết xuất của mã nguồn cụ thể trong 28 triển khai Markdown.

(+ - vượt qua bài kiểm tra, - - không vượt qua, ? - để lại một số rác không được hiển thị trong HTML được hiển thị).

• No empty lines, using <> 13+, 15-
• Empty line before the comment, using <> 20+, 8-
• Empty lines around the comment, using <> 20+, 8-
• No empty lines, using # 13+ 1? 14-
• Empty line before the comment, using # 23+ 1? 4-
• Empty lines around the comment, using # 23+ 1? 4-

Điều này chứng minh các báo cáo ở trên.

Các triển khai này không thực hiện được tất cả 6 thử nghiệm. Không có cơ hội sử dụng nhận xét bị loại trừ khi hiển thị với họ.

• cebe/markdown 1.1.0
• cebe/markdown MarkdownExtra 1.1.0
• cebe/markdown GFM 1.1.0
• s9e \ TextFormatter (Fatdown/PHP)

Answer 9

thế nào về việc đưa các nhận xét vào một khối không phải là eval, không phải là tiếng R? tức là,

```{r echo=FALSE, eval=FALSE} 
All the comments! 
``` 

Dường như làm việc tốt cho tôi.

Answer 10

Bạn có thể thử

[](
Your comments go here however you cannot leave 
// a blank line so fill blank lines with 
// 
Something 
) 

Answer 11

<!--- ... --> 

Không làm việc trong Pandoc Markdown (Pandoc 1.12.2.1). Nhận xét vẫn xuất hiện trong html. Công việc sau đã hoạt động:

Blank line 
[^Comment]: Text that will not appear in html source 
Blank line 

Sau đó, sử dụng phần mở rộng + chú thích cuối trang. Về cơ bản nó là một chú thích không bao giờ được tham chiếu.

Answer 12

Đối với pandoc, cách tốt để chặn nhận xét là sử dụng metamlock yaml, as suggested by the pandoc author. Tôi đã nhận thấy rằng điều này cung cấp cú pháp tô sáng phù hợp hơn cho các nhận xét so với nhiều giải pháp được đề xuất khác, ít nhất là trong môi trường của tôi (vim, vim-pandoc và vim-pandoc-syntax).

Tôi sử dụng nhận xét khối yaml kết hợp với nhận xét html-inline, kể từ html-comments cannot be nested. Thật không may, có no way of block commenting within the yaml metablock, vì vậy mỗi dòng phải được nhận xét riêng lẻ. May mắn thay, chỉ nên có một dòng trong một đoạn được viết mềm.

Trong ~/.vimrc của tôi, tôi đã thiết lập các phím tắt tùy chỉnh để lấy ý kiến ​​khối:

nmap <Leader>b }o<Esc>O...<Esc>{ji#<Esc>O---<Esc>2<down> 
nmap <Leader>v {jddx}kdd 

tôi sử dụng , như <Leader> -key tôi, vì vậy ,b và ,v bình luận và bỏ ghi chú một đoạn, tương ứng. Nếu tôi cần phải bình luận nhiều đoạn, tôi lập bản đồ j,b để macro (thường Q) và chạy <number-of-paragraphs><name-of-macro> (ví dụ (3Q). Các công trình tương tự cho uncommenting.

Answer 13

Vim Instant-Markdown người dùng cần phải sử dụng

<!--- 
First comment line... 
// 
_NO_BLANK_LINES_ARE_ALLOWED_ 
// 
_and_try_to_avoid_double_minuses_like_this_: -- 
// 
last comment line. 
--> 

Answer 14

kramdown cơ markdown -the Ruby-dựa trên là mặc định cho Jekyll và do đó GitHub Pages- has built-in comment support through its extension syntax:

{::comment} 
This text is completely ignored by kramdown - a comment in the text. 
{:/comment} 

Do you see {::comment}this text{:/comment}? 
{::comment}some other comment{:/} 

này có lợi ích của việc cho phép bình luận trực tuyến, nhưng nhược điểm của việc không được di chuyển đến các động cơ Markdown khác.