Skip to content

Commit

Permalink
Rename to remark-highlight.js.
Browse files Browse the repository at this point in the history
  • Loading branch information
wooorm committed Jan 5, 2016
1 parent c693795 commit e739f69
Show file tree
Hide file tree
Showing 5 changed files with 26 additions and 27 deletions.
26 changes: 13 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,26 @@
# [mdast]-highlight.js [![Build Status](https://travis-ci.org/ben-eb/mdast-highlight.js.svg?branch=master)][ci] [![NPM version](https://badge.fury.io/js/mdast-highlight.js.svg)][npm] [![Dependency Status](https://gemnasium.com/ben-eb/mdast-highlight.js.svg)][deps]
# [remark]-highlight.js [![Build Status](https://travis-ci.org/ben-eb/remark-highlight.js.svg?branch=master)][ci] [![NPM version](https://badge.fury.io/js/remark-highlight.js.svg)][npm] [![Dependency Status](https://gemnasium.com/ben-eb/remark-highlight.js.svg)][deps]

> Highlight code blocks in Markdown files with [highlight.js][highlightjs].
## Install

With [npm](https://npmjs.org/package/mdast-highlight.js) do:
With [npm](https://npmjs.org/package/remark-highlight.js) do:

```
npm install mdast-highlight.js --save
npm install remark-highlight.js --save
```

## Example

mdast-highlight.js is designed to work with [mdast-html][html]:
remark-highlight.js is designed to work with [remark-html][html]:

```js
var mdast = require('mdast');
var html = require('mdast-html');
var hljs = require('mdast-highlight.js');
var remark = require('remark');
var html = require('remark-html');
var hljs = require('remark-highlight.js');

var markdown = '```css\nh1 {\n color: red;\n}\n```\n';
var result = mdast.use([ html, hljs ]).process(markdown);
var result = remark.use([ html, hljs ]).process(markdown);
console.log(result);

//=> Compiled HTML with highlighted CSS!
Expand All @@ -35,9 +35,9 @@ to cover it.

MIT © [Ben Briggs](http://beneb.info)

[ci]: https://travis-ci.org/ben-eb/mdast-highlight.js
[deps]: https://gemnasium.com/ben-eb/mdast-highlight.js
[npm]: http://badge.fury.io/js/mdast-highlight.js
[html]: https://github.com/wooorm/mdast-html
[mdast]: https://github.com/wooorm/mdast
[ci]: https://travis-ci.org/ben-eb/remark-highlight.js
[deps]: https://gemnasium.com/ben-eb/remark-highlight.js
[npm]: http://badge.fury.io/js/remark-highlight.js
[html]: https://github.com/wooorm/remark-html
[remark]: https://github.com/wooorm/remark
[highlightjs]: https://github.com/isagalaev/highlight.js
12 changes: 6 additions & 6 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "mdast-highlight.js",
"name": "remark-highlight.js",
"version": "1.2.0",
"description": "Highlight code blocks in Markdown files with highlight.js.",
"main": "dist/index.js",
Expand All @@ -16,24 +16,24 @@
"syntax",
"highlight.js",
"markdown",
"mdast"
"remark"
],
"license": "MIT",
"devDependencies": {
"babel": "^5.8.23",
"babel-tape-runner": "^1.2.0",
"mdast": "^1.2.0",
"mdast-html": "^1.1.0",
"remark": "^3.0.0",
"remark-html": "^2.0.0",
"tap-spec": "^4.1.0",
"tape": "^4.2.0"
},
"homepage": "https://github.com/ben-eb/mdast-highlight.js",
"homepage": "https://github.com/ben-eb/remark-highlight.js",
"author": {
"name": "Ben Briggs",
"email": "beneb.info@gmail.com",
"url": "http://beneb.info"
},
"repository": "ben-eb/mdast-highlight.js",
"repository": "ben-eb/remark-highlight.js",
"dependencies": {
"highlight.js": "^8.8.0",
"unist-util-visit": "^1.0.0"
Expand Down
2 changes: 1 addition & 1 deletion src/__tests__/fixtures/output.html
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<h1>CSS Example</h1>
<pre><code class="hljs language-css"><span class="hljs-tag">h1</span> <span class="hljs-rules">{
<span class="hljs-rule"><span class="hljs-attribute">color</span>:<span class="hljs-value"> red
}</span></span></span></code></pre>
</span></span></span>}</code></pre>
<h1>JS Example</h1>
<pre><code class="hljs language-js"><span class="hljs-function"><span class="hljs-keyword">function</span> (<span class="hljs-params"></span>) </span>{}</code></pre>
<h1>No highlighting</h1>
Expand Down
10 changes: 5 additions & 5 deletions src/__tests__/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@

import test from 'tape';
import hljs from '../';
import mdast from 'mdast';
import html from 'mdast-html';
import remark from 'remark';
import html from 'remark-html';
import {readFileSync as read} from 'fs';
import {join} from 'path';

Expand All @@ -12,15 +12,15 @@ let base = file => read(join(__dirname, 'fixtures', file), 'utf-8');
test('should highlight css & js', t => {
t.plan(1);

let result = mdast.use([ html, hljs ]).process(base('input.md'));
let result = remark.use([ html, hljs ]).process(base('input.md'));
t.equal(result, base('output.html'));
});

test('should not modify existing htmlAttributes and classes', t => {
t.plan(2);

let ast = mdast.parse('```lang\n```', { position: false });
ast = mdast()
let ast = remark.parse('```lang\n```', { position: false });
ast = remark()
.use(() => ast => {
ast.children[0].data = {
htmlAttributes: {
Expand Down
3 changes: 1 addition & 2 deletions src/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,8 @@ export default function attacher () {
data.htmlContent = hljs.highlightAuto(node.value, [node.lang]).value;
data.htmlAttributes = data.htmlAttributes || {};
data.htmlAttributes.class = [
data.htmlAttributes.class,
'hljs',
'language-' + node.lang
data.htmlAttributes.class
].filter(Boolean).join(' ');
}

Expand Down

0 comments on commit e739f69

Please sign in to comment.