Skip to content

Commit

Permalink
modified readme
Browse files Browse the repository at this point in the history
  • Loading branch information
ppwwyyxx committed Aug 11, 2013
1 parent 187544f commit e4a1cdd
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 3 deletions.
6 changes: 5 additions & 1 deletion README.md
Expand Up @@ -3,18 +3,22 @@
This is a [hexo](https://github.com/tommy351/hexo)
tag plugin which allows you to use vim syntax highlight to highlight code inside markdown.

Hexo is a static blogging system written Node.js, it uses highlight.js by default to render code.
Hexo is a static blogging system written in Node.js, it uses [highlight.js](http://softwaremaniacs.org/soft/highlight/en/)
by default to render code.
But lots of languages are not supported by highlight.js (but always supported by vim with proper plugins).
In that case, you can use this instead.

## Installation

You need to have vim properly installed and configured, since this program will directly call vim.

To install, run the following command in the root directory of hexo:
```
npm install hexo-tag-vimhighlight --save
```

And add this plugin in your ``_config.yml``.

## Usage

Specify the code filetype, and whether to use line number in your markdown source file, in
Expand Down
4 changes: 2 additions & 2 deletions package.json
@@ -1,6 +1,6 @@
{
"name": "hexo-tag-vimhighlight",
"version": "0.1",
"version": "0.1.0",
"description": "Highlight code using vim in hexo",
"main": "index",
"repository": {
Expand Down Expand Up @@ -32,5 +32,5 @@
"readmeFilename": "README.md",
"bugs": {
"url": "https://github.com/ppwwyyxx/hexo-tag-vimhighlight/issues"
},
}
}

0 comments on commit e4a1cdd

Please sign in to comment.