Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update both parse and render options in README #68

Merged
merged 1 commit into from
Mar 2, 2018
Merged

Update both parse and render options in README #68

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
19 changes: 10 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -129,24 +129,25 @@ CommonMarker accepts the same options that CMark does, as symbols. Note that the

### Parse options

| Name | Description
| ------------------- | -----------
| `:DEFAULT` | The default parsing system.
| `:SMART` | Use smart punctuation (curly quotes, etc.).
| `:VALIDATE_UTF8` | Replace illegal sequences with the replacement character `U+FFFD`.
| `:LIBERAL_HTML_TAG` | Support liberal parsing of inline HTML tags.
| `:FOOTNOTES` | Parse footnotes.
| Name | Description
| ----------------------------- | -----------
| `:DEFAULT` | The default parsing system.
| `:FOOTNOTES` | Parse footnotes.
| `:LIBERAL_HTML_TAG` | Support liberal parsing of inline HTML tags.
| `:SMART` | Use smart punctuation (curly quotes, etc.).
| `:STRIKETHROUGH_DOUBLE_TILDE` | Parse strikethroughs by double tildes (compatibility with [redcarpet](https://github.com/vmg/redcarpet))
| `:VALIDATE_UTF8` | Replace illegal sequences with the replacement character `U+FFFD`.

### Render options

| Name | Description
| ------------------ | -----------
| `:DEFAULT` | The default rendering system.
| `:SOURCEPOS` | Include source position in rendered HTML.
| `:GITHUB_PRE_LANG` | Use GitHub-style `<pre lang>` for fenced code blocks.
| `:HARDBREAKS` | Treat `\n` as hardbreaks (by adding `<br/>`).
| `:NOBREAKS` | Translate `\n` in the source to a single whitespace.
| `:SAFE` | Suppress raw HTML and unsafe links.
| `:GITHUB_PRE_LANG` | Use GitHub-style `<pre lang>` for fenced code blocks.
| `:SOURCEPOS` | Include source position in rendered HTML.
| `:TABLE_PREFER_STYLE_ATTRIBUTES` | Use `style` insted of `align` for table cells

### Passing options
Expand Down