From e4a1cdd933e8b9c8a699344a9762c08008c826fe Mon Sep 17 00:00:00 2001 From: ppwwyyxx Date: Sun, 11 Aug 2013 20:00:02 +0800 Subject: [PATCH] modified readme --- README.md | 6 +++++- package.json | 4 ++-- 2 files changed, 7 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index aaadbcc..813ac8d 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,8 @@ 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. @@ -11,10 +12,13 @@ In that case, you can use this instead. 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 diff --git a/package.json b/package.json index 9329dda..9d2c3b4 100644 --- a/package.json +++ b/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": { @@ -32,5 +32,5 @@ "readmeFilename": "README.md", "bugs": { "url": "https://github.com/ppwwyyxx/hexo-tag-vimhighlight/issues" - }, + } }