Skip to content

Adds options object and syntax highlighting API #28

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’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
estrattonbailey wants to merge 6 commits into
base: main
Choose a base branch
from
Open

Adds options object and syntax highlighting API #28

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
f411169
Adds options.highlight via additional closure
estrattonbailey Jun 29, 2017
fc1b4af
Adds npm5 lock file
estrattonbailey Jun 29, 2017
3126a10
Don't encode code output if options.highlight is defined
estrattonbailey Jun 29, 2017
2139e2e
Add options doc to README
estrattonbailey Jun 29, 2017
6fe6fc4
Simplify string to remove escapes
estrattonbailey Jun 29, 2017
0509915
Move higlight to global scope. Don't assign lang to save bytes
estrattonbailey Jul 8, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,23 @@ console.log(html);
// <em>this</em> is <strong>easy</strong> to <code>use</code>.
```

### Options
Snarkdown also accepts an optional `options` object.

#### `options.highlight`
Highlight code blocks when parsed. Accepts a function with the signature `hightlight(code, language)`. Return a highlighted string using the library or your choice.
```javascript
import snarkdown from 'snarkdown'
import prism from 'prismjs'

let md = '```javascript \n let md = "a javascript code block";```'
let html = snarkdown(md, {
highlight: (code, language) => {
return prism.highlight(code, prism.languages[language])
}
});
```


## License

Expand Down
Loading