Skip to content

Commit

Permalink
Add note about Markdown, HTML parsing
Browse files Browse the repository at this point in the history
  • Loading branch information
wooorm committed Apr 6, 2020
1 parent 223f72c commit cf8bb5a
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,10 @@

Generate a slug just like GitHub does for markdown headings. It also ensures slugs are unique in the same way GitHub does it. The overall goal of this package is to emulate the way GitHub handles generating markdown heading anchors as close as possible.

This project is not a Markdown or HTML parser: passing `alpha *bravo* charlie`
or `alpha <em>bravo</em> charlie` doesn’t work.
Instead pass the plain text value of the heading: `alpha bravo charlie`.

## Install

```
Expand Down

0 comments on commit cf8bb5a

Please sign in to comment.