Skip to content

Commit 1e1dd2d

Browse files
committed
Clarified that metadata blocks are not processed.
1 parent 8d05f36 commit 1e1dd2d

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ pandoc-comments 0.1.0
66

77
Python is required. Install pandoc-comments using `python setup.py install`. This can be made available via `pip` on request.
88

9-
Block comments are declared in markdown documents by using a percent sign (%) at the beginning of a paragraph. Percent signs may be used on subsequent lines but have no additional effect. For example, see [demo.md]. Inline comments are not supported. Comments in YAML metadata are not supported.
9+
Block comments are declared in markdown documents by using a percent sign (%) at the beginning of a paragraph. Percent signs used on subsequent lines of a paragraph may be used but have no additional effect. For example, see [demo.md]. Inline comments are not supported. Pandoc metadata blocks are not processed by this filter.
1010

1111
Processing [demo.md] with `pandoc -s --filter pandoc-comments` gives output in [md], [pdf], [tex], and [html] formats. Notice that comments are stripped from all output files.
1212

0 commit comments

Comments
 (0)