document the HTML sanitization whitelist #247
Conversation
|
Looks legit. |
document the HTML sanitization whitelist
|
Thanks! |
|
@mojavelinux "Fully document which HTML tags are allowed in GitHub flavored Markdown in the Readme" at #246 was closed because your commit got merged: 8ddb670#diff-04c6e90faac2675aa89e2176d2eec7d8 . Great! But now... the list is gone from the readme again. :( |
|
I replaced it in #431 with a more detailed description of how GitHub renders a README. Since it's not actually this libraries responsibility to perform the sanitization, I think it makes more sense to point people to the code where it happens. It's a constant game of whack-a-mole to update it whenever the HTML Pipeline gets updated. Let me know if you have ideas for how to improve it. |
|
Thanks for the clarification @bkeepers. Perhaps we could emphasize (in bold or italic) the sentence that mentions it. That way, I'm sure it won't be missed. |
| @@ -21,6 +21,30 @@ you wish to run the library. You can also run `script/bootstrap` to fetch them a | |||
| * [.pod](https://search.cpan.org/dist/perl/pod/perlpod.pod) -- `Pod::Simple::HTML` | |||
| comes with Perl >= 5.10. Lower versions should install Pod::Simple from CPAN. | |||
|
|
|||
There was a problem hiding this comment.
Where did all of this go? Where does it live now?
Since this information is important for understanding how AsciiDoc is rendered on GitHub, among other markup languages, I've documented the behavior as I understand it from studying the HTML sanitization filter.