Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/segment-boneyard/highlight
A simple, pluggable API for syntax highlighting.
https://github.com/segment-boneyard/highlight
Last synced: about 2 months ago
JSON representation
A simple, pluggable API for syntax highlighting.
- Host: GitHub
- URL: https://github.com/segment-boneyard/highlight
- Owner: segment-boneyard
- Created: 2014-02-21T02:26:30.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2015-12-13T07:42:51.000Z (almost 9 years ago)
- Last Synced: 2024-05-13T13:21:30.163Z (4 months ago)
- Language: JavaScript
- Size: 16.6 KB
- Stars: 149
- Watchers: 40
- Forks: 10
- Open Issues: 2
-
Metadata Files:
- Readme: Readme.md
- Changelog: History.md
Awesome Lists containing this project
- awesome-github-repos - segment-boneyard/highlight - A simple, pluggable API for syntax highlighting. (JavaScript)
README
# highlight
A simple, pluggable API for syntax highlighting.
Syntax highlighters tend to have pretty opinionated APIs, both in terms of when to highlight, and how to determine the language. And lots bundle the languages directly into the core library, which makes it much harder to reason about them individually, or to have the smallest possible file size if you don't need the esoteric ones.
So... we made this one. The API is very simple, yet still gives you full control. The language definitions are all [separate plugins](#languages), so you get the smallest possible build size, and so that they're simpler for everyone to contribute to. Because regexes are already hard enough to read as it is!
## Installation
$ component install segmentio/highlight
## Example
```js
var Highlight = require('highlight')
var html = require('highlight-xml');
var js = require('highlight-javascript');
var highlight = new Highlight()
.use(html)
.use(js);
var el = document.querySelector('.code-sample');
highlight.element(el);
```
...or if you're lazy, you can just pass a selector string:
```js
highlight.element('.code-sample');
```
...or if you're _incredibly_ lazy, you can just highlight everything:
```js
highlight.all();
```
## Languages
- [Bash](https://github.com/segmentio/highlight-bash)
- [CSS](https://github.com/segmentio/highlight-css)
- [C#](https://github.com/segmentio/highlight-csharp)
- [Go](https://github.com/segmentio/highlight-go)
- [HTML](https://github.com/segmentio/highlight-xml)
- [Java](https://github.com/segmentio/highlight-java)
- [Javascript](https://github.com/segmentio/highlight-javascript)
- [JSON](https://github.com/segmentio/highlight-json)
- [.NET](https://github.com/segmentio/highlight-csharp)
- [Objective-C](https://github.com/segmentio/highlight-objective-c)
- [PHP](https://github.com/segmentio/highlight-php)
- [Python](https://github.com/segmentio/highlight-python)
- [Ruby](https://github.com/segmentio/highlight-ruby)
- [SQL](https://github.com/segmentio/highlight-sql)
- [XML](https://github.com/segmentio/highlight-xml)
- [YAML](https://github.com/segmentio/highlight-yaml)
## API
#### new Highlight()
Create a new `Highlight` instance.
#### #use(plugin)
Apply a `plugin` function, for example language syntaxes.
#### #string(string, language)
Highlight a `string` of code of a given `language`.
#### #element(el, [language])
Highlight an `el`. If you don't pass a `language`, it will use the `data-language` attribute:
```html
YOUR CODE HERE
```
#### #elements(els, [language])
Highlight a series of `els`.
#### #all()
Highlight all of the elements in the DOM that have a `data-language` attribute.
#### #prefix(string)
Set the CSS class name prefix `string`.
#### #language(name, grammar)
Define a new language by `name` with a `grammar`.
#### #parse(string, language)
Return an AST for a given `string` and `language`.
#### #stringify(ast)
Convert an `AST` into a string of HTML.
## License
The MIT License
Copyright © 2014 Segment.io
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.